Each Notice on your page can have multiple updates, each describing the current situation.
NOTE
Creating new updates on a notice will trigger the pages configured publishers such email, SMS, Twitter, Slack and Microsoft Teams.
Endpoint
https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates/(:update_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. |
| content | The text content for this particular update. |
| should_publish | Boolean, was this update sent out through Email, Slack Twitter etc. |
| created_at | The date/time the record was created. |
| updated_at | The date/time the record was last updated. |
List Updates
GET https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates
Example Request
curl -X GET https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates \
-H "Authorization: Bearer 129spul0wcxabrfsnscn6lwrledmp2afbuaxgt1w42s74xds70fgln85e4s3"
Example Response
{
"response": [
{
"id": 50407219,
"content": "We are aware that analytics is experiencing issues with delayed results. We are actively investigating and will provide updates as soon as new information becomes available. ",
"created_at": "2022-12-05T13:49:16.955Z",
"should_publish": false,
"link": "https://status.example-inc.com/notices/1ohdsp7anq7unraf-delayed-results-in-analytics/#update-50407219",
"updated_at": "2022-12-05T13:49:16.955Z"
}
],
"count": 1
}
Create an update
POST https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates
Example Request
curl -X POST https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates \
-d content="We are continuing to investigate the cause of the delayed analytics in Basemetrics. Engineers are prioritising the investigation. Our next update will be in the next 20 minutes." \
-H "Authorization: Bearer Bearer 129spul0wcxabrfsnscn6lwrledmp2afbuaxgt1w42s74xds70fgln85e4s3"
Example Response
{
"response": {
"id": 50407593,
"content": "We are continuing to investigate the cause of the delayed analytics in Basemetrics. Engineers are prioritising the investigation. Our next update will be in the next 20 minutes.",
"created_at": "2022-12-06T08:55:41.052Z",
"should_publish": true,
"link": "https://status.example-inc.com/notices/1ohdsp7anq7unraf-delayed-results-in-analytics/#update-50407593",
"updated_at": "2022-12-06T08:55:41.052Z"
}
}
Get an update
GET https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates/:update_id
Example Request
curl -X GET https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates/:update_id \
-H "Authorization: Bearer 129spul0wcxabrfsnscn6lwrledmp2afbuaxgt1w42s74xds70fgln85e4s3"
Example Response
{
"response": {
"id": 50407219,
"content": "We are aware that analytics is experiencing issues with delayed results. We are actively investigating and will provide updates as soon as new information becomes available. ",
"created_at": "2022-12-05T13:49:16.955Z",
"should_publish": false,
"link": "https://status.example-inc.com/notices/1ohdsp7anq7unraf-delayed-results-in-analytics/#update-50407219",
"updated_at": "2022-12-05T13:49:16.955Z"
}
}
Update a single update
PATCH https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates/:update_id
Example Request
curl -X PATCH https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates/:update_id \
-d content="We are continuing to investigate the cause of the delayed analytics in Basemetrics. Our next update will be in the next 30 minutes." \
-H "Authorization: Bearer 129spul0wcxabrfsnscn6lwrledmp2afbuaxgt1w42s74xds70fgln85e4s3"
Example Response
{
"response": {
"id": 50407593,
"content": "We are continuing to investigate the cause of the delayed analytics in Basemetrics. Our next update will be in the next 30 minutes.",
"created_at": "2022-12-06T08:55:41.052Z",
"should_publish": true,
"link": "https://status.example-inc.com/notices/1ohdsp7anq7unraf-delayed-results-in-analytics/#update-50407593",
"updated_at": "2022-12-06T09:01:07.754Z"
}
}
Delete an update
DELETE https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates/:update_id
Example Request
curl -X DELETE https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates/:update_id \
-H "Authorization: Bearer 129spul0wcxabrfsnscn6lwrledmp2afbuaxgt1w42s74xds70fgln85e4s3"