CHchecklyhq
Alert notifications

Lists all alert notifications

Changed on

Lists the alert notifications that have been sent for your account. You can filter by alert channel ID or limit to only failing notifications.

Use the to and from parameters to specify a date range (UNIX timestamp in seconds). This endpoint will return data within a 24-hour timeframe. If the from and to params are set, they must be at most 24 hours apart. If none are set, we will consider the to param to be now and the from param to be 24 hours earlier. If only the to param is set we will set from to be 24 hours earlier. If only the from param is set we will consider the to param to be 24 hours later.

Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.

get/v1/alert-notifications

Request

Query parameters

limitinteger

Limit the number of results

pagenumber

Page number

fromstring date

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

tostring date

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

alertChannelIdinteger

Limit results to an alert channel

hasFailuresboolean

Sending the alert notification was unsuccessful

Headers

x-checkly-accountstring

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

Response

Successful

idstring

The unique ID of this alert notification.

type'EMAIL' | 'SLACK' | 'SLACK_APP' | 'WEBHOOK' | 'SMS' | 'PAGERDUTY' | 'OPSGENIE' | 'CALL'

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

status'IN_PROGRESS' | 'SUCCESS' | 'FAILURE' | 'RATE_LIMITED'

The status of the alert.

alertConfigAlertConfig

The configuration which was used to send the alert.

notificationResultstring nullable

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

timestampstring date-time nullable

The time that the alert was sent.

checkType'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'TRACEROUTE' | 'URL' | 'DNS' | 'SSL' | 'GRPC'

The type of the check.

checkIdstring

The ID of the check.

checkAlertIdstring

The ID of the check alert.

alertChannelIdnumber

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

checkResultIdstring

The ID of the corresponding check result.

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

  • a4fea1ad9b9aRevision changes
    • warning

      added the new GRPC enum value to the / response property for the response status

    • warning

      added the new SSL enum value to the / response property for the response status

    • warning

      added the new TRACEROUTE enum value to the / response property for the response status