Webhooks

As an Admin, you can view configured webhooks via the API.

List Webhooks

GET/settings/webhooks Bearer Token

Retrieve a list of configured outgoing webhooks.

Response

Success (200):

{
  "data": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "url": "https://example.com/webhook",
      "event_types": [
        "order.created",
        "order.delivered"
      ],
      "active": true,
      "created_at": "2025-01-10T08:00:00Z"
    }
  ],
  "meta": {}
}

Show Webhook

GET/settings/webhooks/{item} Bearer Token

Retrieve a single webhook configuration by ID.

Response

Success (200):

{
  "data": {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "url": "https://example.com/webhook",
    "event_types": ["order.created", "order.delivered"],
    "active": true,
    "created_at": "2025-01-10T08:00:00Z"
  },
  "meta": {}
}