Skip to navigation

Test alert webhook

View as Markdown
Test alert webhook

Request

This endpoint expects an object.
webhookobjectRequired
idstringOptionalformat: "uuid"
namestringOptional0-255 characters
enabledbooleanOptional
alert_typeenumOptional
Allowed values:
metadatamap from strings to stringsOptional
custom_fieldsmap from strings to stringsOptional

Optional user-defined key/value pairs, added as top-level keys of the alert’s EventBridge event detail. Keys must not collide with the event’s own keys.

triggerslist of objectsOptional
project_idstringOptionalformat: "uuid"

Optional project scope for this alert. When set, the alert is scoped to the specified project. Do NOT also provide a ‘scope:project’ trigger config — the system will create it automatically from this field. Sending both project_id and a scope:project trigger config will result in an error.

Response

Webhook test
statusenumOptional
Allowed values:
status_codeintegerOptional
request_bodystringOptional
error_messagestringOptional

Errors

422
Unprocessable Entity Error