Skip to main content
POST
/
v1
/
alert-channels
Create an alert channel
curl --request POST \
  --url https://api.checklyhq.com/v1/alert-channels \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "subscriptions": [],
  "type": "SMS",
  "config": {},
  "sendRecovery": true,
  "sendFailure": true,
  "sendDegraded": true,
  "sslExpiry": false,
  "sslExpiryThreshold": 30,
  "autoSubscribe": false
}'
{
  "id": 1,
  "type": "SMS",
  "config": {},
  "subscriptions": [],
  "sendRecovery": true,
  "sendFailure": true,
  "sendDegraded": true,
  "sslExpiry": false,
  "sslExpiryThreshold": 30,
  "autoSubscribe": false,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

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

Body

application/json
​
type
enum<string>
required
Available options:
EMAIL,
SLACK,
WEBHOOK,
SMS,
PAGERDUTY,
OPSGENIE,
CALL
Example:

"SMS"

​
config
object
required
​
subscriptions
object[]

All checks subscribed to this channel.

Example:
[]
​
sendRecovery
boolean
​
sendFailure
boolean
​
sendDegraded
boolean
​
sslExpiry
boolean
default:false

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

​
sslExpiryThreshold
integer
default:30

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

Required range: 1 <= x <= 30
​
autoSubscribe
boolean
default:false

Automatically subscribe newly created checks to this alert channel.

Response

Created

​
id
number
required
Example:

1

​
type
enum<string>
required
Available options:
EMAIL,
SLACK,
WEBHOOK,
SMS,
PAGERDUTY,
OPSGENIE,
CALL
Example:

"SMS"

​
config
object
required

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

​
subscriptions
object[]

All checks subscribed to this channel.

Example:
[]
​
sendRecovery
boolean
​
sendFailure
boolean
​
sendDegraded
boolean
​
sslExpiry
boolean
default:false

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

​
sslExpiryThreshold
integer
default:30

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

Required range: 1 <= x <= 30
​
autoSubscribe
boolean
default:false

Automatically subscribe newly created checks to this alert channel.

​
created_at
string<date-time>
​
updated_at
string<date-time>
⌘I