Skip to main content

List all webhooks

Returns a list of your webhooks. The webhooks are returned sorted by creation date, with the most recently created webhooks appearing first.

Parameters​

No parameters.

Returns​

Return a paginated response that contains an array of up to the specified limit of webhooks.

get
/api/webhooks
curl https://{workspace}.kitchen.co/api/webhooks \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "data": [
    {
      "id": "wh_4c49373b8698d4ceac793e0f",
      "url": "http://www.goodwin.com/unde-aut-iusto-quidem-amet-nihil",
      "events_types": [
        "invoice.deleted",
        "list.deleted",
        "quote.updated"
      ],
      "attempts_count": 0,
      "failed_attempts_count": 0,
      "enabled": true,
      "secret": "secret",
      "created_at": "2024-06-22T23:08:44+00:00",
      "updated_at": "2024-06-22T23:08:44+00:00"
    }
  ],
  "links": {
    "first": "/api/webhooks?page=1",
    "last": "/api/webhooks?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "/api/webhooks?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "/api/webhooks",
    "per_page": 20,
    "to": 1,
    "total": 1
  }
}