Skip to content

Commit deced44

Browse files
committed
Document scheduled publishing for incidents and maintenance
Add a "Published At" field and a "Scheduling publication" section to the incidents and schedules guides, explaining that a future publish date hides the item from the status page and public API until then, while keeping it visible in the dashboard and MCP, and defers subscriber notifications to publish time. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NCuvKjgerpaWvGcmY57G95
1 parent 72fbd7b commit deced44

2 files changed

Lines changed: 40 additions & 0 deletions

File tree

v3.x/guide/incidents.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ the dashboard. Incidents consist of:
1111
- **Status**: The current status of the incident.
1212
- **Message**: A detailed description of the incident.
1313
- **Occurred At**: The time the incident occurred. This can be left empty if the incident happened at the time of reporting.
14+
- **Published At**: An optional time to publish the incident. While set in the future, the incident is hidden from the status page and public API until that moment. Leave it empty to publish immediately.
1415
- **Visibility**: Whether the incident should be visible to users, guests or always be hidden.
1516

1617
The Cachet dashboard provides a simple interface to manage incidents. You can quickly record a new incident by clicking the
@@ -27,6 +28,25 @@ Incidents and updates in Cachet can have one of the following statuses:
2728
- <Tooltip tip="Status ID: 3"><Icon icon="square-3" /></Tooltip> **Watching**: The incident or the resolution is being watched.
2829
- <Tooltip tip="Status ID: 4"><Icon icon="square-4" /></Tooltip> **Fixed**: The incident is fully resolved.
2930

31+
## Scheduling publication
32+
33+
Incidents don't have to go live the moment you create them. By setting a **Published At** date in the future, you can
34+
prepare an incident ahead of time and have it appear automatically when that time arrives.
35+
36+
Until the published date passes, the incident is treated as a draft:
37+
38+
- It is hidden from the status page and the public [API](/api-reference/introduction), regardless of whether the viewer is logged in.
39+
- It remains fully visible and editable in the dashboard and over the [MCP server](/v3.x/guide/mcp), so you can review and adjust what you've prepared.
40+
- Any [subscriber notifications](/v3.x/guide/subscribers) are deferred — they are sent when the incident is published, not when it is created.
41+
42+
Leave **Published At** empty (the default) to publish the incident immediately, preserving the usual behaviour.
43+
44+
<Note>
45+
Publication is evaluated in real time, so an incident appears the moment its published date passes. Subscriber
46+
notifications are dispatched by the scheduled `cachet:publish-scheduled` command, so make sure Cachet's
47+
[scheduler](/v3.x/installation) is running.
48+
</Note>
49+
3050
## Incident components
3151

3252
Incidents don't typically occur in isolation. They often affect one or more [components](/v3.x/guide/components) of the service. Cachet allows you

v3.x/guide/schedules.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ A scheduled maintenance event consists of:
1313
- **Message**: A detailed description of the maintenance.
1414
- **Scheduled At**: The date and time when the maintenance will start.
1515
- **Completed At**: The date and time when the maintenance was completed.
16+
- **Published At**: An optional time to publish the maintenance. While set in the future, the maintenance is hidden from the status page and public API until that moment. Leave it empty to publish immediately.
1617

1718
### Schedule statuses
1819

@@ -22,6 +23,25 @@ Cachet automatically infers the status of a schedule based on the current date a
2223
- **In Progress**: The maintenance is currently in progress.
2324
- **Complete**: The maintenance has been completed.
2425

26+
## Scheduling publication
27+
28+
You can prepare maintenance well in advance without revealing it straight away. By setting a **Published At** date in the
29+
future, the maintenance stays a draft and appears automatically once that time arrives.
30+
31+
Until the published date passes:
32+
33+
- The maintenance is hidden from the status page and the public [API](/api-reference/introduction), whether or not the viewer is logged in.
34+
- It stays fully visible and editable in the dashboard and over the [MCP server](/v3.x/guide/mcp).
35+
- Any [subscriber notifications](/v3.x/guide/subscribers) are deferred until the maintenance is published.
36+
37+
This is independent of **Scheduled At**, which controls when the maintenance window itself begins. Leave **Published At**
38+
empty to publish the maintenance immediately.
39+
40+
<Note>
41+
Subscriber notifications for published maintenance are dispatched by the scheduled `cachet:publish-scheduled`
42+
command, so make sure Cachet's [scheduler](/v3.x/installation) is running.
43+
</Note>
44+
2545
## Schedule updates
2646

2747
You may need to provide an update on scheduled maintenance, for example if the maintenance is taking longer than expected, or

0 commit comments

Comments
 (0)