Models
The Webhook endpoint object
Every field of the Webhook endpoint object, with types, required flags and validation rules.
The Webhook endpoint object
| Field | Type | Description |
|---|---|---|
id | string | e.g. whe_4b8s1 |
object | string | always webhook_endpoint |
url | string | uri |
events | array of EventType | |
status | string | one of: enabled, disabled, auto_disabled |
created_at | string | ISO 8601 |
Request models
What you send when creating or updating. Fields not listed are ignored.
WebhookEndpointCreate
| Field | Type | Required | Description |
|---|---|---|---|
url | string | required | HTTPS only. Private/internal addresses are rejected. Uri |
events | array of EventType | required | min 1 items |
WebhookEndpointUpdate
| Field | Type | Required | Description |
|---|---|---|---|
url | string | optional | uri |
events | array of EventType | optional | |
status | string | optional | one of: enabled, disabled |
Last updated on October 16, 2026
Need help?
Email us and a human replies, usually within one business day.