Articles in this section

Get Webhooks

Avatar
John Twomey
  • Updated
Follow

Retrieve all registered webhooks.

GET ~/webhooks

Headers

Field Type Description
doshii-location-idoptional String

The hashed ID of the location you're targeting. See Hashed Location IDs. If the optional doshii-location-id header should be omitted, the endpoint will retrieve all registered webhooks. If the header is supplied, only those webhooks explicitly registered for the supplied location will be returned.

Response

Field Type Description
event String

The Doshii event that this webhook is subscribed to
webhookUrl String

A valid URL, hosted external to Doshii, that is capable of receiving POST requests with the Doshii events
authenticationEnabled boolean

Indicates whether or not authentication credentials have been associated to the webhook
updatedAt String

Date when the webhook was last updated
createdAt String

Date when the webhook was created
uri String

The object details url

Examples

Response

[{
    "event": "order_created",
    "webhookUrl": "https://some.external.site/doshii/webhook",
    "authenticationEnabled": true,
    "uri": "http://sandbox.doshii.co/partner/v3/webhooks/order_created",
    "updatedAt": "2018-07-17T07:52:28.122Z",
    "createdAt": "2018-07-17T07:52:28.122Z"
},
{
    "event": "order_updated",
    "webhookUrl": "https://some.external.site/doshii/webhook",
    "authenticationEnabled": true,
    "uri": "http://sandbox.doshii.co/partner/v3/webhooks/order_updated",
    "updatedAt": "2018-07-17T07:55:28.122Z",
    "createdAt": "2018-07-17T07:55:28.122Z"
}]

 

Related articles

Comments

0 comments

Please sign in to leave a comment.