Sign in
Webhooks

Create a new webhook endpoint

Create a new webhook endpoint to receive events.

post/v1/webhooks/endpoints

Headers

X-API-Keystring

API key

Request body

urlstring uri required

The webhook endpoint URL

descriptionstring required

Description of the endpoint

filterTypesstring[]

Event types to send to this endpoint. Omit or pass an empty array to subscribe to all event types.

metadataobject

Optional endpoint metadata

Example request

{
  "url": "https://api.example.com/webhooks",
  "description": "Production webhook endpoint",
  "filterTypes": [
    "customer.created",
    "customer.updated"
  ]
}

Response

Webhook endpoint created successfully

idstring required

Endpoint ID

urlstring required

The webhook endpoint URL

descriptionstring required

Description of the endpoint

filterTypesstring[] required

Event types sent to this endpoint. An empty array means the endpoint is subscribed to all event types.

disabledboolean required

Whether the endpoint is disabled

createdAtstring required

Endpoint creation timestamp

updatedAtstring required

Endpoint last update timestamp

metadataobject

Optional endpoint metadata

Example response

{
  "id": "ep_1234567890abcdef",
  "url": "https://api.example.com/webhooks",
  "description": "Production webhook endpoint",
  "filterTypes": [
    "customer.created",
    "customer.updated"
  ],
  "createdAt": "2026-09-15T10:30:00Z",
  "updatedAt": "2026-09-15T10:30:00Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.