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: { "transformation_rule_id": <id> }, a single object (a Webhook has at most one). Omitting or null unbinds it.
routing_bindingsarrayNo[]List of { routing_rule_id, priority }. Omitting or null removes all bindings.

Binding a Transformation Rule

transformation holds exactly one key, the ID of an existing Transformation Rule:

{
  "name": "Datadog alerts",
  "auth_mode": "standard",
  "is_enabled": true,
  "default_schedule_id": 12,
  "transformation": { "transformation_rule_id": 34 },
  "routing_bindings": [
    { "routing_rule_id": 56, "priority": 1 }
  ]
}

To unbind, omit transformation or send null — there is no separate "unbind" field.

Responses add a read-only _name to transformation and to each routing_bindings entry so the UI can show the referenced rule's name. It is display-only; the binding is defined solely by the ID.