List alert channels

Lists where this website can send notifications: Slack, Google Chat, Microsoft Teams, Telegram, a webhook of your own, or email. Webhook URLs, bot tokens and signing secrets are never returned, only a masked preview of the destination and whether a secret is set.

Requires the viewer role on the website and the alerting plan feature.

Authorization

AuthorizationBearer <token>

An OpenID Connect access token issued by Keycloak, acting as the signed-in user.

In: header

Path Parameters

workspaceId*string

websiteId*string

Query Parameters

cursor?string

The nextCursor of the previous page. Omit it to start from the beginning. A cursor encodes a position and is not meant to be built by hand.

limit*|

How many items to return, from 1 to 200.

Range1 <= value <= 200

Default50

q?string

Match part of the channel name.

Lengthlength <= 255

type?AlertChannelType

Where notifications are sent.

Value in

"slack"
"google-chat"
"teams"
"telegram"
"webhook"
"email"

enabled?boolean

Only enabled or only disabled channels.

Response Body

`application/json`

curl -X GET "https://example.com/v1/workspaces/string/websites/string/alerts/channels?limit=50"

{  "data": [    {      "id": "string",      "workspaceId": "string",      "websiteId": "string",      "name": "Security channel",      "type": "string",      "configPreview": "https://hooks.slack.com/…AbCd",      "hasSecret": true,      "emailRecipients": [        {          "memberId": "string",          "userId": "string",          "hasAccess": true,          "email": "string",          "firstName": "string",          "lastName": "string",          "picture": "string"        }      ],      "enabled": true,      "disabledReason": "string",      "consecutiveFailures": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true,    "total": 0  }}