v1

latestOpenAPI 3.1.02026-07-26102934.7 KB

webhooks

Create webhook

Creates a new webhook subscription. The response includes a secret that you should store securely — it is used to verify webhook signatures and is only returned once at creation time.

post/webhooks

Request body

urlstring required

The HTTPS URL that will receive webhook events. Must be publicly accessible. Max 2048 characters.

eventsWebhookEvent[] required

List of events to subscribe to. At least one event is required.

enabledboolean

Whether the webhook is active. Set to false to create it in a disabled state.

Example request

{
  "url": "https://example.com/webhooks/timeless"
}

Response

The created webhook including the signing secret.

idstring required

Webhook ID.

urlstring required

The registered URL.

eventsWebhookEvent[] required

Subscribed events.

enabledboolean required

Whether the webhook is active.

created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

secretstring required

HMAC signing secret. Store this securely — it is only returned on creation.

Example response

{
  "id": "whk_abc123",
  "secret": "a1b2c3d4e5f6..."
}