The Webhook Object
Webhooks are scoped to the App Client Credentials that created them.
apiVersion read-only
The API version the Webhook was created with and expects to receive payloads as. |
createdOn read-only
A date and time when the webhook was created in ISO 8601 format. |
description
An optional description you may provide for your own reference. |
events
An array containing event scope strings. An event scope may be a precise match, or contain a wildcard. For example, product/created listens exclusively to when a new product is created and
product/* listens to all product events.
You may listen to multiple events on a single webhook. |
id read-only
The unique webhook subscription ID. |
isActive
A boolean indicating whether the webhook is enabled or disabled. A webhook may be disabled manually or due to repeat failed attempts. |
metadata
An object containing key-value pairs that may be supplied with each webhook as metadata. |
modifiedOn read-only
A date and time when the webhook was last modified in ISO 8601 format. |
url
The destination/endpoint URL where webhooks will be sent as a POST request. Must be an absolute URL with HTTPS scheme. |
Example
An example of a webhook subscription response when created.
{
"success": true,
"status": 200,
"data": {
"id": 65436453,
"apiVersion": "v2",
"description": null,
"url": "https://webhooks.my-domain.com/webhook-consumer",
"events": [
"products/*",
"categories/*",
],
"metadata": {
"integration-key": "afacc52a-8513-11ec-a8a3-0242ac120002"
},
"isActive": true,
"createdOn": "2022-02-03T16:43:49+00:00",
"modifiedOn": "2022-02-03T16:43:49+00:00"
}
}