Get a single Webhook
GET
/api/v2/webhooks/{id}.json
Retrieve a single Webhook subscription using its ID.
Scopes
Requires the default API scope only.
Parameters
Accepts the following parameters:
id
required
The ID of the Webhook subscription is supplied as a path parameter. |
Response
Returns an object with the following properties:
success
A boolean where a value of true represents a successful request.
|
status
The HTTP status code e.g. 200 for a successful request.
|
data
Contains the Webhook object. |
JSON Example
An example of JSON returned.
{
"success": true,
"status": 200,
"data": {
"id": 65436453,
"apiVersion": "v2",
"description": null,
"url": "https://webhooks.my-domain.com/webhook-consumer",
"events": [
"product/*",
"category/*",
],
"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"
}
}