Alerts

Test alert webhook

Changed on

Test alert webhook

post/v1/private/alerts/webhooks/tests

Request

  • Base URL
    http://localhost:5173/api
  • URL
    http://localhost:5173/api/v1/private/alerts/webhooks/tests
  • Auth
    none declared

Request body

idstring uuid
namestring
enabledboolean
alert_type'general' | 'slack' | 'pagerduty'
metadataobject
custom_fieldsobject

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.

project_idstring 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

status'success' | 'failure'
status_codeinteger
request_bodystring
error_messagestring

Changes