Incidents

In Cachet, an incident represents any ongoing issue or event that affects the service. You can manage incidents via the dashboard. Incidents consist of:

• Name: A brief description of the incident.
• Status: The current status of the incident.
• Message: A detailed description of the incident.
• Occurred At: The time the incident occurred. This can be left empty if the incident happened at the time of reporting.
• 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.
• Visibility: Whether the incident should be visible to users, guests or always be hidden.
• Pinned: Whether the incident is pinned to the top of your status page. Pinned incidents remain prominently displayed until you unpin them.

To record an incident, click New Incident in the dashboard’s top navigation bar. To view and manage existing incidents, click Incidents in the sidebar.

​

Pinned incidents

Enable Pinned when creating or editing an incident to pin it above the incident timeline on your status page. Pinned incidents remain at the top even when their Occurred At date falls outside the timeline’s selected date range, making them useful for ongoing issues and important resolved incidents that need continued visibility. Pinned incidents appear only in the pinned section, not in their normal dated position in the timeline. You can pin more than one incident. Cachet orders pinned incidents from newest to oldest by their occurrence time. Disable Pinned to return an incident to its usual position in the timeline.

​

Incident statuses

Incidents and updates in Cachet can have one of the following statuses:

• Reported: The incident has been reported.
• Investigating: The incident is actively being investigated.
• Identified: The cause of the incident has been identified.
• Watching: The incident or the resolution is being watched.
• Fixed: The incident is fully resolved.

​

Scheduling publication

To prepare an incident before publishing it, set Published At to a future date and time. The incident appears automatically at that time. Until the published date passes, the incident is treated as a draft:

• It is hidden from the status page and from public reads of the API, including requests from guests and read-only API tokens.
• It remains fully visible and editable in the dashboard, over the MCP server, and to API tokens with the incidents.manage ability, so you can review and adjust what you’ve prepared.
• Cachet sends subscriber notifications when the incident is published, not when it is created.

Leave Published At empty to publish the incident immediately. This is the default.

​

Incident components

Link an incident to the components it affects to show which parts of your service have a problem. After creating an incident, edit it and click Attach in the Components panel. When attaching a component, you can also select a new status for that component.

​

Incident updates

Add updates to an incident to keep users informed as the issue develops. Incident updates consist of:

• Message: A detailed description of the update.
• Status: The status of the incident after the update.

To update an incident, open Incidents in the dashboard and click Record Update on the incident.

​

Incident templates

Incident templates let you reuse content when creating incidents. Cachet supports two templating languages: To create an incident from a template through the API, pass the template and its variables. Cachet fills in the template with the values you provide.