Create a webhook
Creates a new webhook endpoint to receive real-time event notifications.
Parameters
Request Body
name
string
Required
Friendly name for the webhook endpoint
url
string
Required
URL that will receive webhook POST requests. HTTPS is strongly recommended but not enforced — an
http:// URL is accepted.event_types
array
Required
Events to subscribe to (use "all" for all events)
description
string
Optional note stored with the webhook and returned when you read it back.
is_active
boolean
Whether the webhook is active
retry_attempts
integer
Number of retry attempts on failure (0-10). Not validated as an integer — a fractional value is accepted.
timeout
integer
Request timeout in seconds (5-60). Not validated as an integer — a fractional value is accepted.
auth_type
string (none | basic | bearer | custom)
Authentication method for your endpoint
auth_config
object
Authentication credentials (depends on auth_type)
custom_headers
object
Additional HTTP headers to include in requests
Returns
201
Webhook created
400
Invalid request data
401
Authentication required
403
PLAN_UPGRADE_REQUIRED — webhooks are not available on the current plan.
Related
Webhooks
POST/api/v1/webhooks