Webhooks

Endpoints for creating, reading, and deleting webhooks.

List Webhooks

This endpoint allows you to list your webhooks.

Parameters

Name	Type	Description
before	string	A pagination cursor for entries before a specific point in the collection.
after	string	A pagination cursor for entries after a specific point in the collection.
limit	integer	The maximum number of entries to retrieve (defaults to 20, up to 100 allowed).

Response

When successful, returns a Paginated List of Webhook resources.

{
  "entries": [
    // items
  ],
  "metadata": {
    "before": null,
    "after": "g3QAAAABZAACaWRiAAAbFA==",
    "limit": 20
  }
}

Get Webhook

This endpoint allows you to fetch a single webhook.

Response

When successful, returns a Webhook resource.

{
  "id": "wh_01ED74HMFGVZ92YVCWTD8Y8H6X",
  // ...
}

It the resource does not exist or is not accessible, returns a not found response.

Create Webhook

This endpoint allows you to create a new webhook.

Parameters

Name	Type	Description
url	string	The URL to receive HTTP POST requests.

Response

When successful, returns the Webhook resource.

{
  "id": "wh_01ED74HMFGVZ92YVCWTD8Y8H6X",
  // ...
}

If the URL provided is not valid, returns validation errors.

{
  "errors": {
    "url": [{"message": "must be a valid URL"}]
  }
}

Delete Webhook

This endpoint allows you to delete a new webhook.

Response

When successful, returns the Webhook resource.

{
  "id": "wh_01ED74HMFGVZ92YVCWTD8Y8H6X",
  "state": "deleted"
  // ...
}