Skip to content
Docs
Status Incidents
Getting Started

Getting Started

Projects in Status Incidents are services or applications that are being monitored for incidents. This page provides an overview of how to manage Projects in Status Incidents.

A project can be monitored, and incidents can be created for it. Projects can also have multiple services, and each incident can have multiple affected services.

Configuring the bot

We strongly recommend performing the following actions before creating a project:

  • Use the /admin-role command to ensure that only users with a specific role can perform administrative actions.
  • Use the /admin-log-channel to ensure that all actions are logged to a specific channel.

Use the /projects create command

Use the /projects create command to create a Project in Status Incidents.

Check out the Create Project Options section for a list of available options.

project-webhook

Configure Services

Use the /services create command to create a Service (or services) for the Project. This step is optional, but it is recommended to configure services for the project when applicable.

These are recommended because they allow you to organize your incidents and provide more context to your users.

services-overview create-service

Configure Statuses

Use the /statuses edit command to edit a Status (or statuses) for the Project. This step is optional, and allows you to use custom labels, emojis, colors and statuses altogether for your projects.

configure-statuses

Configure Embeds

Use the /embeds configure command to edit Incidents embeds for this Project. This step is optional, and allows you to customize the embeds for your incidents on a per-project basis.

configure-embeds

Configure RSS Feeds

You can subsribe to any RSS feed to get updates on incidents. Use the /projects rss-feeds add command to subscribe to an RSS feed for this Project. This step is optional, and allows you to get updates on incidents from your favorite RSS feeds with the same context and configuration as your incidents.

Create Project Options

  • name - The name of the project.
  • webhook-url - The webhook URL for the project, this is where incident messages will be sent (displayed in GIF).
  • description - (optional) The description of the project.
  • default-message - (optional) The default message for incidents, you can ping roles and users here.
  • can-subsribe - (optional) Whether users can subscribe to be notified of incidents for this project.

For more information about commands, check out the /commands command.

OverviewIncidents