Alerts
Enterprise

Test Alert Webhook

Changed on

Synchronously dispatches a mock payload for the given event_type to the webhook's target URL using the current HMAC secret. No alert_attempts row is persisted. The handler returns 200 for both successful and failed upstream deliveries; the status_code and error fields in the response body surface the upstream outcome.

post/api/v2/alert-webhooks/{alert_webhook_id}/test

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/alert-webhooks/{alert_webhook_id}/test
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Request body

event_typestring required

The alert event type to mock in the dispatched payload. The server builds a representative payload for the given type using the webhook's current HMAC secret.

versioninteger required

Payload data version for the supplied event_type. Must be one of the data versions advertised for that type by GET /api/v2/alert-event-types.

Response

OK

Changes