v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Webhooks

List all webhook endpoints

The endpoint returns a list of webhooks.

get/v1/webhooks/

Query parameters

enabledboolean

Filter by active (true) or disabled (false) webhooks.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

countinteger required

nextstring uri nullable

previousstring uri nullable

Example response

{
  "results": [
    {
      "id": "48427a36d43c4d5aa6324bc06c692456",
      "webhook_url": "http://example.com/",
      "events": [
        "task-status-updated",
        "order-status-updated"
      ],
      "env_type": "dev",
      "created_at": "2022-05-04T11:30:00Z",
      "updated_at": "2022-05-04T12:00:00Z"
    }
  ]
}