WebhookEndpointCreate
March 5, 2026 ยท View on GitHub
Schema to create a webhook endpoint.
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
url | str | :heavy_check_mark: | The URL where the webhook events will be sent. | https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0 |
name | OptionalNullable[str] | :heavy_minus_sign: | An optional name for the webhook endpoint to help organize and identify it. | |
format_ | models.WebhookFormat | :heavy_check_mark: | N/A | |
events | List[models.WebhookEventType] | :heavy_check_mark: | The events that will trigger the webhook. | |
organization_id | OptionalNullable[str] | :heavy_minus_sign: | The organization ID associated with the webhook endpoint. Required unless you use an organization token. | 1dbfc517-0bbf-4301-9ba8-555ca42b9737 |