POST
/hooks/queuealertsCreate Queuealerts
Implementation Notes
This API call uses a Web Hook to deliver the queue status to a designated endpoint you specify. If a hook is defined, the status—whether successful completion or termination due to an error—will be sent to your endpoint.Authentication types and its descriptions:
- None - No authentication required. Users can access resources without providing any credentials.
- Basic - Username and password required. Users must provide their credentials for verification.
- Bearer - Token-based authentication. Users present a valid access token to access resources.
- Header - API key in header: API key is provided as a specific header value (e.g., "X-Api-Key").
POST
/hooks/queuealertsParameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
body | body | Optional | none | |
» endpoint | body | string | Optional | none |
» authtype | body | string | Optional | none |
» username | body | string | Optional | none |
» password | body | string | Optional | none |
» token | body | string | Optional | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Authentication Failed or Account validity expired | None |
| 500 | Internal Server Error | Internal server error | None |
Example Request
# You can also use wget
curl -X POST /hooks/queuealerts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Body Parameter
{
"queueid": 31570988,
"rateshopid": 28719364,
"statuscode": 2,
"statusmessage": "Completed",
"creditused": 240,
"totalrows": 1003
}
Example responses
200 Response
{
"requestid": "string",
"message": "string"
}Need Support?
Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.