How to fetch a specific webhook via API
Last updated 5 months ago
To a single webhook, send a GET request to the /api/webhooks/:id endpoint, where id is the ID of the resource that you want to retrieve.
GET
/api/webhooks/:id
id
GET https://yourdomain.commercelayer.io/api/webhooks/:id
The following request fetches the webhook identified by the id "xYZkjABcde":
curl -g -X GET \ 'https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde' \ -H 'Accept: application/vnd.api+json' \ -H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK status code, returning a single resource object:
200 OK
{ "data": { "id": "xYZkjABcde", "type": "webhooks", "links": { "self": "https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde" }, "attributes": { "name": "myorg-orders.place", "topic": "orders.place", "callback_url": "https://yourapp.com/webhooks", "include_resources": [ "customer", "shipping_address", "billing_address" ], "disabled_at": "2018-01-01T12:00:00.000Z", "shared_secret": "1c0994cc4e996e8c6ee56a2198f66f3c", "created_at": "2018-01-01T12:00:00.000Z", "updated_at": "2018-01-01T12:00:00.000Z", "reference": "ANY-EXTERNAL-REFEFERNCE", "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "metadata": { "foo": "bar" } }, "relationships": { "last_event_callbacks": { "links": { "self": "https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde/relationships/last_event_callbacks", "related": "https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde/last_event_callbacks" } }, "versions": { "links": { "self": "https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde/relationships/versions", "related": "https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde/versions" } } }, "meta": { "mode": "test", "organization_id": "xRRkjDFafe", "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74" } } }