Validate Webhook

Validates a webhook body against the same schema, URL rules, and body template check used by POST /api/v2/webhooks. The webhook is never persisted. Use this endpoint at plan time (e.g. from a Terraform provider) to check that a webhook configuration is valid before applying it. Name uniqueness is not checked.

POST /api/v2/webhooks/validate

Error

A valid request URL is required to generate request examples

200

valid

{ "valid": true, "errors": [], "normalized": { "name": "Alerts", "service": "generic", "url": "https://example.com/webhooks/alerts", "body": "{\"alert\": \"{{title}}\"}" } }

Autorizações

Authorization · string · header · obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json

Webhook create/update body. body, headers, and queryParams only take effect for services that issue a templated HTTP request (generic, incidentio). The slack service posts a fixed payload to its incoming-webhook URL and ignores them, so supplying any of these fields on a slack webhook is rejected. headers and queryParams are write-only — they are accepted here but never returned by any read endpoint, so secrets such as auth tokens do not leak. On update (PUT), omitted readable fields (description, body) are cleared, while omitted headers/queryParams are preserved — send an explicit {} to clear them. Exception: if the destination (url or service) changes, omitted headers/queryParams are cleared rather than preserved, so stored secrets are never forwarded to a new destination; re-supply them for the new destination.

name · string · obrigatório

Webhook name. Must be unique per service within the team.

Maximum string length: 1024

Exemplo:

"Production Alerts"

service · enum<string> · obrigatório

Webhook service type.

Opções disponíveis: slack, incidentio, generic

Exemplo:

"slack"

url · string<uri> · obrigatório

Webhook destination URL.

Maximum string length: 2048

Exemplo:

"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"

description · string

Webhook description, shown in the UI.

Maximum string length: 2048

Exemplo:

"Sends critical alerts to the #incidents channel"

body · string

Optional Handlebars request body template. Only for generic/incidentio; rejected for slack. Rejected with a 400 if it does not compile or calls a helper other than eq and the Handlebars built-ins.

Maximum string length: 16384

Exemplo:

"{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}"

headers · object

Write-only. Custom HTTP headers sent with the webhook request. Never returned on read. Only for generic/incidentio; rejected for slack. Each value is capped at 4096 characters.

Show child attributes

Exemplo:

{ "Authorization": "Bearer secret-token" }

queryParams · object

Write-only. Query parameters appended to the webhook URL. Never returned on read. Only for generic/incidentio; rejected for slack. Each value is capped at 4096 characters.

Show child attributes

Resposta

200

application/json

Validation result. HTTP 200 is always returned for valid and invalid bodies — a non-200 response means the request itself failed (auth, server error, etc.).

valid · boolean · obrigatório

True when the body passes all validation rules.

errors · object[] · obrigatório

Validation errors. Empty when valid is true.

Show child attributes

normalized · object | null · obrigatório

The parsed webhook body, without the write-only headers and queryParams. Populated when valid is true, null when valid is false.