OverviewPlatformsAPI Reference
Alerts

List channels

Lists the workspace's channels with their settings and delivery stats.

GET
/v1/channels

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/channels"
{  "data": [    {      "id": "string",      "label": "string",      "stats": {        "alerts": 0,        "activeAlerts": 0,        "lastDeliveryAt": "string",        "last7d": {          "total": 0,          "failed": 0        }      },      "createdAt": "string",      "kind": "slack",      "config": {        "channelId": "string",        "channelName": "string",        "events": [          "mention.spike"        ]      }    }  ]}
Was this page helpful?

List a channel's deliveries

Lists the mentions, digests and account events sent to the channel, latest first, with status and the last error. `limit` defaults to 50, up to 200.

Mute authors

Adds authors to the alert's muted list and leaves the rest of its filter alone. Links are handled as in the dashboard, so a post link mutes its author, twitter.com turns into x.com and a Hacker News profile keeps its id. Authors who are already muted are skipped, so retrying is safe. An entry that is not a person, such as a subreddit or a story, fails the request and the error names it.