API REFERENCE · SCHEMA

WebhookRequest schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

urlRequired
string

HTTPS endpoint that receives signed events. Public DNS resolution and destination restrictions apply; local/private addresses and redirects are rejected. At most five active endpoints per environment.

Format: uri. Maximum length: 2048.

Additional fields are not accepted.

Use WebhookRequest in a workflow

Used by

Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.

Implementation guides