Comment on page

Webhook

Webhook schema
id long
Webhook ID
_cloudId integer
Cloud ID (add link)
_warehouseId long?
Warehouse ID (add link)
method string
Webhook HTTP method to be requested when the entity is updated
url string
Webhook URL to be requested when the entity is updated. Validated by a regex.
payloadEntity string
The name of an entity associated with the webhook
Can be one of the following: "STOCKLOG", "POINTSLOG", "PRODUCT","ORDERBEAN", "RESERVATION"
payloadVersion string
Version of the entity to be put into the webhook body
The only value currently supported is "V1" i.e. field names will be compatible with VS/API1
versionDate timestamp?
Version date in ISO or Timestamp format
JSON response
{
    "id": <long>,
    "_cloudId": <integer>,
    "_warehouseId": <long>,
    "method": <string>,
    "url": <string>,
    "payloadEntity": <string>,
    "payloadVersion": <string>,
    "versionDate": <timestamp>
}
get
https://api.dotykacka.cz/v2
/clouds/:cloudId/webhooks
Get all webhooks
post
https://api.dotykacka.cz/v2
/clouds/:cloudId/webhooks
Register a webhook
delete
https://api.dotykacka.cz/v2
/clouds/:cloudId/webhooks/:webhookId
Delete a webhook

Others - Previous

Breaking changes

Next - Others

Third-party libraries

Last modified 1yr ago