API reference
Search
K
Links

List all webhooks

How to fetch a collection of webhooks via API
To fetch a collection of webhooks, send a GET request to the /api/webhooks endpoint.

Request

GET https://yourdomain.commercelayer.io/api/webhooks

Example

Request
Response
The following request fetches a collection of webhooks:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/webhooks/' \
-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 paginated collection of resource objects:
{
"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"
],
"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"
},
"disabled_at": "2018-01-01T12:00:00.000Z",
"shared_secret": "1c0994cc4e996e8c6ee56a2198f66f3c"
},
"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"
}
},
{
"other": "... 9 webhooks (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/webhooks?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/webhooks?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/webhooks?page[number]=14&page[size]=10"
}
}
Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of webhooks can be sorted by the following fields:
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin
  • disabled_at
  • circuit_state
  • circuit_failure_count

Filterable fields

The list of webhooks can be filtered by the following fields:

Attributes

  • name
  • topic
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin
  • metadata
  • disabled_at
  • circuit_state
  • circuit_failure_count