Articles in this section

Update Webhook

Avatar
John Twomey
  • Updated
Follow

Update a webhook subscription.

PUT ~/webhooks/:event

Headers

Field Type Description
doshii-location-idoptional 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 update the location-specific webhook.

Parameters

Field Type Description
:event String

The name of the Doshii event that the webhook subscription is being updated for.
webhookUrl URL

A valid URL, hosted external to Doshii, that is capable of receiving POST requests with the Doshii events. See Webhook Verification for more details.
authenticationKeyoptional String

The key used in the webhook authentication. See Webhook Authentication for more details.
authenticationTokenoptional String

The token used in the webhook authentication. See Webhook Authentication for more details.

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
webhookLatency Number

Specifies the time in milliseconds it took for your webhook to respond to the verification process. See Webhook Verification for more details.
updatedAt String

Date when the webhook was last updated
createdAt String

Date when the webhook was created
uri String

The object details url

Examples

Request: Update a webhook subscription

{
    "webhookUrl": "https://some.external.site/doshii/webhook",
    "authenticationKey": "secure_key",
    "authenticationToken": "secure_token"
}

Response

{
    "event": "order_created",
    "webhookUrl": "https://some.external.site/doshii/webhook",
    "authenticationEnabled": true,
    "webhookLatency": 5000,
    "uri": "http://sandbox.doshii.co/partner/v3/webhooks/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.