Skip to main content
POST
cURL

Headers

Authorization
string
required

Bearer token. Format: Bearer <api_key>

Body

application/json

Request body for registering a webhook endpoint.

url
string
required

HTTPS URL that will receive webhook deliveries.

eventTypes
string[]

Event types to subscribe to. Omit to receive all event types.

description
string

Optional human-readable description.

Response

The request has succeeded.

A registered webhook endpoint. Delivery, retries, and signing are handled by Svix.

object
enum<string>
required

Object type. Always webhook_endpoint.

Available options:
webhook_endpoint
id
string
required

Unique endpoint identifier.

url
string
required

HTTPS URL that receives webhook deliveries.

description
string
required

Optional human-readable description.

disabled
boolean
required

When true, the endpoint stays registered but receives no deliveries.

eventTypes
string[]
required

Event types this endpoint is subscribed to. Empty means all event types.

createdAt
string
required

When the endpoint was created.

updatedAt
string
required

When the endpoint was last updated.