OverviewPlatformsAPI Reference
Alerts

Test a channel

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

POST
/v1/channels/{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 channel's id (dest_...).

Length1 <= length

Response Body

application/json

application/json

application/json

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

Test an alert

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

Unmute authors

Takes authors off the muted list, keeping the rest of the filter. Each entry can be the stored value or any link to the person's profile or posts. Retrying is safe, because authors who aren't muted are skipped.