Create webhook

Create a new webhook configuration. Maximum 10 webhooks per user.

name, url and events are required. url must be a valid URL and events must contain at least one event. Whitespace is trimmed from url before validation.

Webhooks are automatically disabled after 10 consecutive delivery failures.

POST /v1/webhooks/settings

Create a new webhook configuration. Maximum 10 webhooks per user.

name, url and events are required. url must be a valid URL and events must contain at least one event. Whitespace is trimmed from url before validation.

Webhooks are automatically disabled after 10 consecutive delivery failures.

Request body

Content-Type: application/json

• name (string) required — Webhook name (1-50 characters)
• url (string) required — Webhook endpoint URL (must be a valid URL, whitespace trimmed)
• secret (string) — Secret key for HMAC-SHA256 signature verification
• events (array) required — Events to subscribe to (at least one required)
• isActive (boolean) — Enable or disable webhook delivery. Defaults to true when omitted.
• customHeaders (object) — Custom headers to include in webhook requests

Responses

200 — Webhook created successfully

• success (boolean)
• webhook ($ref)

400 — Validation error or maximum webhooks reached

401