HOhoneybadger
Incidents

Create an incident

Creates an incident on a status page. An incident needs at least one update, and its prose, status and severity come from its updates.

post/status_pages/{status_page_id}/incidents

Request

Path parameters

status_page_idstring required
Example:Sp7bMq

Status page ID

Request body

titlestring required
build_type'current' | 'retroactive' | 'scheduled_maintenance'

How the incident was opened. current is happening now, retroactive records something already over, scheduled_maintenance is planned. Only a scheduled_maintenance incident may have updates starting in the future.

retro_should_notifyboolean

Announce a retroactive incident when it is created

retro_notify_messagestring nullable

Message accompanying that announcement

Example request

{
  "title": "Elevated error rates",
  "updates": [
    {
      "status": "investigating",
      "severity": "partial_outage",
      "message": "Some requests to the API are failing. We're looking into it."
    }
  ]
}

Response

Incident created

Example response

{
  "data": {
    "id": "In3pKr",
    "status_page_id": "Sp7bMq",
    "title": "Database connectivity issues",
    "updates": [
      {
        "id": "Iu6tMn",
        "incident_id": "In3pKr",
        "message": "We have identified the cause and are rolling back."
      }
    ],
    "links": {
      "web": "https://app.honeybadger.io/projects/Xk9mZp"
    }
  },
  "meta": {
    "request_id": "6f1c2b0e-8d4a-4f6e-9b2a-3c5d7e9f1a2b"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.