Remove a webhook subscription
If the optional locationId parameter is supplied, the referenced webhook will be the one registered against the supplied location. If no location is specified (or the reserved ID of all is submitted) then the webhook that is removed will be the global webhook, meaning any event from any subscribed location. The omission of both locationId and event effectively results in the call becoming ~/webhooks/all/all.
DELETE ~/webhooks/:locationId/:event
DELETE ~/webhooks/all/:event
DELETE ~/webhooks/:locationId
DELETE ~/webhooks
Headers
| Field | Type | Description |
|---|---|---|
| Authorization | String |
Bearer authentication token prefixed with |
| Content-Type | String |
Request content type, must be 'application/json' |
| vendor | String |
The POS vendor name retrieved from Doshii dashboard |
Parameters
| Field | Type | Description |
|---|---|---|
| locationIdoptional | String |
The hashed ID of the location you're targeting. See Hashed Location IDs. If the webhook was originally created as a global webhook, then the doshii-location-id should be omitted, otherwise it will attempt to delete any location-specific webhook. |
| eventoptional | String |
The name of the Doshii event that the webhook subscription was created for. This property can be omitted or the reserved event name of all can be supplied to reference the global webhook for all Doshii events to this webhook. |
Examples
Response (204)
204 No Content.
Comments
0 comments
Please sign in to leave a comment.