Skip to main content
POST
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Body

application/json
url
string
required

The webhook endpoint URL

Example:

"https://api.example.com/webhooks"

description
string
required

Description of the endpoint

Example:

"Production webhook endpoint"

filterTypes
string[]

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

Example:
metadata
object

Optional endpoint metadata

Response

Webhook endpoint created successfully

id
string
required

Endpoint ID

Example:

"ep_1234567890abcdef"

url
string
required

The webhook endpoint URL

Example:

"https://api.example.com/webhooks"

description
string
required

Description of the endpoint

Example:

"Production webhook endpoint"

filterTypes
string[]
required

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

Example:
disabled
boolean
required

Whether the endpoint is disabled

Example:

false

createdAt
string
required

Endpoint creation timestamp

Example:

"2026-09-15T10:30:00Z"

updatedAt
string
required

Endpoint last update timestamp

Example:

"2026-09-15T10:30:00Z"

metadata
object

Optional endpoint metadata