OverviewPlatformsAPI Reference
Alerts

Test an alert

Sends a test message to each of the alert's channels now and returns each outcome. Webhooks receive the event test.

POST
/v1/alerts/{id}/test

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Path Parameters

id*string

The alert's id (feed_...).

Length1 <= length

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/alerts/feed_abc123/test"
{  "outcomes": [    {      "channelId": "string",      "ok": true,      "error": "string"    }  ]}
Was this page helpful?

Send a digest now

Sends the digest for the alert's last hour, day or week now and returns each channel's outcome. Works on digest alerts only, and the schedule doesn't change.

Test a channel

Sends a test message to the channel now and returns the outcome. Webhooks receive the event `test`.