Articles in this section

Get Webhook

Avatar
John Twomey
  • Updated
Follow

Retrieve a specific webhook for a given Doshii event.

GET ~/webhooks/:locationId/:event

Headers

Field Type Description
Authorization String

Bearer authentication token prefixed with Bearer and a space. See Authentication for more information. This endpoint uses the Vendor Authentication to authenticate.
Content-Type String

Request content type, must be 'application/json'
vendor String

The POS vendor name retrieved from Doshii dashboard

Parameters

Field Type Description
locationId 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 locationId should be referenced with the reserved ID of all.
event String

The name of the Doshii event that the webhook subscription was created for. This reserved event name of all can be supplied to reference the global webhook for all Doshii events.

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/pos/v3/webhooks/all/order_created",
    "updatedAt": "2018-07-17T07:52:28.122Z",
    "createdAt": "2018-07-17T07:52:28.122Z"
}

 

Related articles

Comments

0 comments

Please sign in to leave a comment.