Skip to main content
GET
/
v1
/
alert-notifications
Lists all alert notifications
curl --request GET \
  --url https://api.checklyhq.com/v1/alert-notifications \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "type": "EMAIL",
    "status": "IN_PROGRESS",
    "alertConfig": {},
    "notificationResult": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "checkType": "API",
    "checkId": "<string>",
    "checkAlertId": "<string>",
    "alertChannelId": 123,
    "checkResultId": "<string>"
  }
]

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

Query Parameters

​
limit
integer
default:10

Limit the number of results

Required range: 1 <= x <= 100
​
page
number
default:1

Page number

​
from
string<date>

Select documents up from this UNIX timestamp (>= date). Defaults to now - 6 hours.

​
to
string<date>

Optional. Select alerts up to this UNIX timestamp (< date). Defaults to 6 hours after "from".

​
alertChannelId
integer

Limit results to an alert channel

​
hasFailures
boolean

Sending the alert notification was unsuccessful

Response

Successful

​
id
string

The unique ID of this alert notification.

​
type
enum<string>

The type of alert channel (SMS, Slack, Webhook, etc).

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

The status of the alert.

Available options:
IN_PROGRESS,
SUCCESS,
FAILURE,
RATE_LIMITED
​
alertConfig
object

The configuration which was used to send the alert.

​
notificationResult
string

The result of sending the alert notification.For example, this could be the response body of the Webhook.

​
timestamp
string<date-time>

The time that the alert was sent.

​
checkType
enum<string>

The type of the check.

Available options:
API,
BROWSER,
HEARTBEAT,
MULTI_STEP,
TCP,
PLAYWRIGHT,
URL,
DNS
​
checkId
string

The ID of the check.

​
checkAlertId
string

The ID of the check alert.

​
alertChannelId
number

The ID of the alert channel which this alert was sent to.

​
checkResultId
string

The ID of the corresponding check result.

⌘I