API Reference
Start typing to search…

Create an incident

post
https://api.checklyhq.com/v1/incidents

Creates a new incident.

Body Params
string
required

A name used to describe the incident.

string
enum
required
Defaults to MINOR

Used to indicate the impact or severity.

Allowed:
date-time

Used to indicate when incident starts to be active.

date-time

Used to indicate when incident turns to inactive.

number
required

The dashboard ID where the incident will be shown.

incidentUpdates
array of objects
required

The first incident update with the status and description. It must be only one element.

incidentUpdates*
Headers
string

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

Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago