CentralCSP
APIAlerts

Get an alert channel

Returns one channel, without its URL or secret.

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

GET
/v1/workspaces/{workspaceId}/websites/{websiteId}/alerts/channels/{channelId}

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

websiteId*string

The website's id.

channelId*string

The alert channel's id.

Response Body

A destination for alerts.

application/json
  1. response
id*string

The channel's id.

workspaceId*string

The workspace's id.

websiteId*string

The website's id.

name*string

Display name.

type*string

The channel type: slack, google-chat, teams, telegram, webhook or email.

configPreview*string

A masked view of the destination: the URL's origin and last few characters, the Telegram chat id, or the recipients' addresses. Full URLs and secrets are never returned.

hasSecret*boolean

Whether a secret is set: a signing secret for a webhook, a bot token for Telegram.

emailRecipients*array<>|

The members an email channel notifies. null for other types.

enabled*boolean

A disabled channel receives nothing.

disabledReason*|

Why the channel was switched off. delivery_failures means it was switched off automatically after repeated failures.

consecutiveFailures*|

Failed deliveries in a row. The channel is switched off at five, and the count resets on a success or when you enable it again.

createdAt*string

When the channel was created.

Formatdate-time
updatedAt*string

When the channel was last changed.

Formatdate-time
Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/websites/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/alerts/channels/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90'
Example Response
{  "id": "string",  "workspaceId": "string",  "websiteId": "string",  "name": "Security channel",  "type": "slack",  "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": "delivery_failures",  "consecutiveFailures": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}