Post an incident on a status page
create_status_page_incidentOpen a new incident on a public status page with its first message to inform visitors about an outage and email confirmed subscribers; confirm wording before posting.
Instructions
Open a new incident on a status page with its first message, to tell the page's visitors about an outage. It is public and emails the page's confirmed subscribers: confirm the wording with the user before calling. Any status but RESOLVED emails every confirmed subscriber at once; RESOLVED records an already closed incident (a postmortem) and emails nobody. To add to an existing incident use post_status_page_update. Requires a key with the write scope. Returns the incident. Example: {"page_id": "", "title": "API errors", "body": "We are investigating elevated error rates."}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The first message. The message subscribers read, 1 to 5000 characters. | |
| title | Yes | The incident's headline, 1 to 255 characters. | |
| status | No | INVESTIGATING, IDENTIFIED, MONITORING or RESOLVED; RESOLVED closes the incident on the page. Default INVESTIGATING. | |
| page_id | Yes | The status page's uuid from list_status_pages. An id that is not a status page of this organization is a 404. | |
| component_ids | No | The affected components: uuids from get_status_page. An id that is not a component of this page is a 404. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| title | Yes | ||
| status | Yes | Known values: INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED. | |
| is_auto | Yes | ||
| updates | Yes | ||
| started_at | Yes | ||
| notified_at | Yes | ||
| resolved_at | Yes | ||
| component_ids | Yes |