Back to Home

Webhook configuration

A Webhook receives alerts from external systems and routes them to a schedule. A Webhook belongs to a Team and references a default Schedule, so create the Team and Schedule first.

Declarative update behavior. This resource is applied declaratively. transformation and routing_bindings are not preserved when omitted. Omitting a field (or sending null) unbinds it. When updating a Webhook, always include the values you want to keep — otherwise existing bindings are removed.

Fields

FieldTypeRequiredDefaultNotes
namestringYesWebhook name. Cannot be empty.
descriptionstringNo""Free-text description. Up to 500 characters.
auth_modestringYesOne of standard or secure.
is_enabledbooleanNofalseWhether the webhook is active. A missing value is treated as false.
default_schedule_idnumberYesThe Schedule that receives alerts when no routing rule matches. Must reference an existing Schedule.
transformationobjectNoTransformation rule binding. Omitting or null unbinds it.
routing_bindingsarrayNo[]List of { routing_rule_id, priority }. Omitting or null removes all bindings.