POST
/hooks/shopalertsCreate Shop Alerts
Create Shop Alerts
Implementation Notes:
This API call uses a Web Hook to deliver the Queue status to a specified endpoint. Once a hook is defined, the status whether a successful completion will be sent to your endpoint.
Mandatory Fields:
- Endpoint
- Authtype (Can be “none”, “basic”, “querystring”, “authheader”, “header”, “bearer”)
- Token OR Username & Password
POST
/hooks/shopalertsParameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
body | body | object | 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 |
|---|---|---|---|
| 201 | Created | Success | |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Authorization Failed | None |
| 409 | Conflict | Already Exists | None |
| 429 | Too Many Requests | Too Many Requests | None |
| 500 | Internal Server Error | Internal Server Error | None |
Example Request
# You can also use wget
curl -X POST http://localhost:3000/hooks/shopalerts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: API_KEY'
Body parameter
{
"endpoint": "www.sample.com",
"authType": "Basic",
"userName": "username",
"password": "password",
"token": "********"
}
Example responses
201 Response
{
"requestId": 1,
"message": "Hook created successfully"
}
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.