Webhooks v3
Get a Webhook
GET /stores/{store_hash}/v3/hooks/{webhook_id}
Request
Return a webhook by ID.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - string
- Content-Type in header with default of application/json - string
example
Response
Example response
Body
dataobject
metaobject
application/json
Update a Webhook
PUT /stores/{store_hash}/v3/hooks/{webhook_id}
Request
Updates a webhook. Custom headers can be added.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - string
- Content-Type in header with default of application/json - string
Body
scopestring
Event you subscribe to.
Example: store/order/*
destinationstring
URL must be active, return a 200 response, and be served on port 443. Custom ports arenʼt currently supported.
Example: https://665b65a6.ngrok.io/webhooks
is_activeboolean
Boolean value that indicates whether the webhook is active or not.
Example: true
events_history_enabledboolean
Boolean value that identifies whether events are stored that could not be received.
Example: true
headersobject or null
Headers used to validate that webhooks are active. You can pass in any number of custom headers to validate webhooks are being returned.
example
Response
Example response
Body
dataobject
metaobject
application/json
Delete a Webhook
DELETE /stores/{store_hash}/v3/hooks/{webhook_id}
Request
Deletes a webhook. Only one webhook at a time can be deleted. When a webhook is deleted, it is returned in the response as a 200 OK.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - string
- Content-Type in header with default of application/json - string
example
Response
Example response
Body
dataobject
metaobject