New notices should be created for each incident you want listed on your status page, with additional comments added or state changes made using PUT requests.
NOTE
Creating new notices, and updating existing notices will trigger their publication not only to the Status Page but also to any configured notifications methods such as Slack, Microsoft Teams or Twitter.
Endpoint
https://api.sorryapp.com/v1/pages/:page_id/notices/(:notice_id)
Object
These are the attributes which represent the object, most of which can be posted too and received in response to the actions.
| Attribute Name | Description |
|---|---|
| id | The unique identifier for the notices. |
| type | Either ‘planned’ or ‘unplanned’, planned notices include expected start times and durations, often used for maintenance. |
| subject | The subject for a notice i.e. API Performance Issues |
| synopsis | A short description of the notice, taken from the first comment/update. |
| state | The current state of the notice. Available states depend on the notice type. For planned: ‘scheduled’, ‘underway’, ‘complete’ and for unplanned: ‘investigating’, ‘identified’, ‘recovering’, ‘resolved’ and ‘false_alarm’ |
| synopsis | A short description of the notice, taken from the first comment/update. |
| timeline_state | This gives you an idea of whether a notice is ‘future’, ‘present’, ‘past_recent’ or ‘past_distant’. Past notices are those which are closed or resolved, _recent and _distant depend on whether it was closed in the past 7 days, or previously. (Read-only) |
| begins_at (‘planned’ only) | The date/time a planned notice is expected to go underway. |
| ends_at (‘planned’ only) | The date/time a planned notice is expected to be complete. |
| began_at | The date/time the notice was opened (if unplanned), or went underway (if planned). |
| ended_at | The date/time the notice was closed (if unplanned), or was complete (if planned). |
| should_automate_schedule (‘planned’ only) | A boolean to determine if planned notices should automatically switch to ‘underway’ and ‘complete’ at the scheduled times. |
| created_at | The date/time the record was created. |
| updated_at | The date/time the record was last updated. |
| link | A permanent link to the notice on the public status page. |
| include | components, updates |