Show Developer Menu

POST /incidents

Issuing a POST call to incidents will allow you to create a new incident.

Example Request
curl 'https://{brand}' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  -X POST -d '{ "incident": { "title": "Shipment issues", "updates_attributes": [{ "status": "investigating", "message": "Currently having an issue with shipments" }], "incidents_systems_attributes": [{ "system_id": "system-id", "status": "partial_outage", }] } }'

A successful request will return the JSON for the newly created incident.

A failed request will return an HTTP 422 Unprocessable Entity with the JSON body explaining the error.

  • The incidents_systems_attributes attribute is optional.
  • The status attribute in updates_attributes can be one of the following: [investigating, identified, monitoring, resolved]
  • The status attribute in incidents_systems_attributes can be one of the following: [operational, degraded_performance, partial_outage, major_outage, under_maintenance]