Sign in
Alert channels

List all alert channels

Lists all configured alert channels and their subscribed checks.

get/v1/alert-channels

Query parameters

limitinteger

Limit the number of results

Limit the number of results

pagenumber

Page number

Page number

Headers

x-checkly-accountstring

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

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"
        }
      },
      "references": [
        {
          "binding": {
            "logicalId": "homepage-check"
          }
        }
      ]
    }
  }
]

Changes

Changed in 1 of the 4 revisions of this API.1

  • 87d29dc7b4fe1See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 566 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog