Draft a status page post
draft_status_page_postDraft incident or update text for a status page from its monitor outages, without posting or emailing. Review and edit the draft before publishing it yourself.
Instructions
Write the text of the page's next incident post from the monitor outages affecting it. It only drafts: nothing is posted and no subscriber is emailed. Show the draft to the user and post it with create_status_page_incident (a new-incident draft) or post_status_page_update (an update draft) only after the user confirms; both email the page's subscribers. Without incident_id it drafts a new incident; with incident_id, the next update of that open incident (it says resolved once every outage behind it has recovered). Returns kind (OPENING for a new incident, UPDATE for an update), title (null for an update), status, body, component_ids, basis, source_incident_ids, existing_incident_ids and generated_at. basis says what the text rests on: NONE (no incident data, so the text is generic), CAUSE (incident cause and times) or DIAGNOSIS (also the stored diagnosis). Say so when basis is NONE and let the user edit the text. existing_incident_ids lists incidents already posted on this page for an ongoing outage: update one of them rather than opening a duplicate (one already resolved takes only a RESOLVED entry). Errors: Not found: (unknown page, component or incident); a resolved incident is a 409; incident_id together with component_ids is "Invalid request:". For incidents already posted see list_status_page_incidents. Example: {"page_id": ""}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | |
| incident_id | No | Draft the next update of this open status page incident: an id from list_status_page_incidents. Omit it to draft a new incident. Not with component_ids. | |
| component_ids | No | New incident only: the components it is about, uuids from get_status_page. Omit to draft from every component of the page. Not with incident_id. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Suggested post text, ready for the form. | |
| kind | Yes | OPENING fills the new-incident form, UPDATE the update form. Known values: OPENING, UPDATE. | |
| basis | Yes | What the text rests on: NONE (no incident data), CAUSE (incident cause and times) or DIAGNOSIS (also the stored diagnosis). Known values: NONE, CAUSE, DIAGNOSIS. | |
| title | Yes | Suggested incident title; null for an update draft. | |
| status | Yes | Suggested status. Known values: INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED. | |
| generated_at | Yes | When the draft was written (UTC). Times in the text are absolute UTC; the text adds a date to any time not on this UTC day. | |
| component_ids | Yes | Components the post is about: for an opening draft, the requested ones or those with an ongoing incident; for an update, the incident's own. | |
| source_incident_ids | Yes | Monitor incidents the draft was written from. | |
| existing_incident_ids | Yes | Opening draft only: incidents already published on this page (not deleted) that cover an ongoing outage; post an update to them instead. An automatic incident resolved by hand while its outage goes on is listed too: it still takes a RESOLVED timeline entry, but a drafted update for it answers 409. |