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

payloadEntity string The name of an entity associated with the webhook Can be one of the following: "STOCKLOG", "POINTSLOG", "PRODUCT","ORDERBEAN"

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
Get all webhooks

https://api.dotykacka.cz/v2/clouds/:cloudId/webhooks
Get a list of all configured webhooks.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK

post
Register a webhook

https://api.dotykacka.cz/v2/clouds/:cloudId/webhooks
Register a new webhook.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK

delete
Delete a webhook

https://api.dotykacka.cz/v2/clouds/:cloudId/webhooks/:webhookId
Delete a single webhook identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
webhookId
required
integer
ID of the webhook to delete.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK