API REFERENCE · SCHEMA

WebhookCreated 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.

idRequired
string

Format: uuid.

environmentRequired
string

Values: "sandbox", "production".

urlRequired
string
secretRequired
string

Signing secret shown only at creation. Store securely and use it to verify webhook signatures; list operations never return it.

Use WebhookCreated 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