CHchecklyhq
Alert channels

Retrieve an alert channel

Changed on

Show details of a specific alert channel.

get/v1/alert-channels/{id}

Request

Path parameters

idinteger required

Headers

x-checkly-accountstring

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

idnumber required
type'EMAIL' | 'SLACK' | 'SLACK_APP' | 'WEBHOOK' | 'SMS' | 'PAGERDUTY' | 'OPSGENIE' | 'CALL' required
configAlertChannelConfig required

The configuration details for this alert channel. These can be very different based on the type of the channel.

sendRecoveryboolean
sendFailureboolean
sendDegradedboolean
sslExpiryboolean

Determines if an alert should be sent for expiring SSL certificates.

sslExpiryThresholdinteger

At what moment in time to start alerting on SSL certificates.

autoSubscribeboolean

Automatically subscribe newly created checks to this alert channel.

created_atstring date-time
updated_atstring date-time nullable

Example response

{
  "id": 1,
  "type": "SMS",
  "subscriptions": [],
  "projectBindings": {
    "owner": {
      "binding": {
        "logicalId": "homepage-check",
        "sourceFile": "src/__checks__/homepage.check.ts"
      }
    },
    "references": [
      {
        "binding": {
          "logicalId": "homepage-check",
          "sourceFile": "src/__checks__/homepage.check.ts"
        }
      }
    ]
  }
}

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

  • aba5d34c749bRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status