POST
/endpoint/Create Hook
Register a WebHook Endpoint
This API call allows you to set up a WebHook that receives data generated by EventsShop.
Once a WebHook is defined, data is automatically delivered to the specified endpoint.
The WebHook will send POST requests with JSON payloads corresponding to eventsinfo, eventimpact, or hoteldemand data.
Authentication:
- The user must provide either Basic Auth (Username & Password) or OAuth 2.0 (Token).
- If Basic Auth is used, the system will generate a new token.
Supported Authentication Types: - "authType": "Basic Auth" - "authType": "OAuth 2.0"
This API call allows you to set up a WebHook that receives data generated by EventsShop.
Once a WebHook is defined, data is automatically delivered to the specified endpoint.
The WebHook will send POST requests with JSON payloads corresponding to eventsinfo, eventimpact, or hoteldemand data.
Authentication:
- The user must provide either Basic Auth (Username & Password) or OAuth 2.0 (Token).
- If Basic Auth is used, the system will generate a new token.
Supported Authentication Types: - "authType": "Basic Auth" - "authType": "OAuth 2.0"
POST
/endpoint/Mandatory Fields
- authType
- endpoint
Parameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
body | body | Required | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Successfully registered the WebHook. | None |
| 400 | Bad Request | Bad Request - Invalid or missing parameters. | None |
| 401 | Unauthorized | Unauthorized - Authentication failed. | 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 /endpoint/ \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'Body parameter
{
"authType": "",
"endpoint": "",
"userName": "",
"password": "",
"token": ""
}Example Input 1 (Basic Auth):
{
"authType": "Basic Auth",
"endpoint": "http://35.84.42.213:5000/",
"userName": "events",
"password": "*******",
"token": "71a49c4c-5694-11ec-bf63-0242ac130002"
}
Example Input 2 (OAuth 2.0):
{
"authType": "OAuth 2.0",
"endpoint": "http://35.84.42.213:5000/",
"userName": "events",
"password": "*******",
"token": "71a49c4c-5694-11ec-bf63-0242ac130002"
}
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.