Statuspage steps
Flow Designer has a number of built-in steps to help you integrate Statuspage into your event management and incident response flows.
The following steps are available:
- Create Incident: automatically post a new incident to a page in Statuspage, populating it with information from the event or previous steps in the flow.
- Update Incident: automatically update an incident in Statuspage as information about the event changes.
In the example above, the flow creates a Jira Cloud issue when a certain response is selected. This creates a Statuspage incident with details from the originating system and the Jira Cloud issue. A ServiceNow issue is created and the Statuspage incident is updated to include the ServiceNow incident number in the metadata.
To use these steps, you need an existing page to post the incident to.
Adding Statuspage steps to your flow
- To add a Statuspage step to your flow, go to the Apps panel in the palette, expand the Statuspage steps and drag the step you want to add onto the canvas.
- Connect the step to the previous step in the flow so you have access to the alert properties and outputs of previous steps when configuring this step's inputs.
- Double-click the step to edit it, and use the Setup tab to configure the inputs. You can use plain text and input variables (or both). See the sections below for detailed information on the inputs for each step, including which are required.
- On the Endpoint tab, select a pre-existing endpoint or create a new endpoint , setting the 'Base URL' to the URL of the Statuspage API (https://api.statuspage.io) and the 'Endpoint Type' to No Authentication. Authentication is done using the API Key and Page ID you set in the step inputs.
- If you're planning to use Statuspage steps in other flows, consider creating constants for your API Key and Page ID— that way you won't have to manually enter them every time, and if they change you can easily update them across all your steps.
- Click Done.
Create Incident
Use the Create Incident step to automatically post a new incident to a page. Map outputs from previous steps to the inputs to complete the incident details.
Create Incident inputs and outputs
Inputs
Inputs with an asterisk* are required.
|
Label API mapping |
Description |
|---|---|
|
API Key* api_key |
The API token to use to authenticate with Statuspage. To find the token, go to Manage Account > API in your Statuspage management console. |
|
Page ID* page_id |
The ID of the page you want to post the incident to. To find the page ID, go to Manage Account > API in your Statuspage management console. |
|
Name* incident.name |
The incident name you want to display on the page (for example, "Database queries timing out"). |
|
Status incident.status |
The status you want to assign to the incident that is created. This defaults to investigating if left blank. |
|
Body incident.body |
The message to post as the first incident update. You can use HTML to add style or structure the message. |
|
Impact Override incident.impact_override |
Use this field to override the impact value calculated by Statuspage. This defaults to none if left blank. |
|
Metadata incident.metadata |
Internal metadata to attach to the incident, sent as a parsable JSON string where the top level values represent objects. |
Outputs
These outputs are available as inputs to steps further along the flow.
|
Label API mapping |
Description |
|---|---|
|
Incident ID id |
The unique ID assigned to the incident by Statuspage. You can use this ID as an input to an Update Incident step further along the flow. |
|
Created created_at |
The timestamp of when the incident was created. |
|
Impact impact |
Impact of the incident recorded in Statuspage. |
|
Name name |
Incident name displayed in Statuspage. |
|
Shortlink shortlink |
The shortlink assigned to the incident by Statuspage. You can use this output as part of a message to a chat channel in a step further along the flow. |
|
Status status |
The status that was assigned to the incident. |
|
Updated updated_at |
The date and time the incident was posted to the page. |
Update Incident
Use the Update Incident step to automatically update the information on an existing incident. Map outputs of previous steps to the inputs to determine which incident to update and to update the details.
Update Incident inputs and outputs
Inputs
Inputs with an asterisk* are required; leave any other fields blank to keep the current values.
|
Label API mapping |
Description |
|---|---|
|
API Key* api_key |
The API key to pass to Statuspage for authentication. To find the token, go to Manage Account > API in your Statuspage management console. |
|
Page ID* page_id |
The ID of the page you want to post the incident to. To find the page ID, go to Manage Account > API in your Statuspage management console. |
|
Incident ID* id |
The unique ID assigned to the incident by Statuspage. You can use this ID as an input to an Update Incident step further along the flow. |
|
Name incident.name |
The incident name you want to display on the page. |
|
Status incident.status |
The status you want to update the incident to (for example, monitoring). |
|
Body incident.body |
The message to display as the body of the incident. You can use HTML to add style or structure the message (see the Statuspage help for details). |
|
Impact Override incident.impact_override |
Use this field to override the impact value calculated by Statuspage. |
|
Metadata incident.metadata |
Internal metadata to attach to the incident, sent as a parsable JSON string where the top level values represent objects. |
Outputs
These outputs are available as inputs to steps further along the flow.
|
Label API mapping |
Description |
|---|---|
|
Incident ID id |
The unique ID assigned to the incident by Statuspage. You can use this ID as an input to an Update Incident step further down the flow. |
|
Created created_at |
The timestamp of when the incident was created. |
|
Impact impact |
Impact of the incident recorded in Statuspage. |
|
Name name |
Incident name displayed in Statuspage. |
|
Shortlink shortlink |
The shortlink assigned to the incident by Statuspage. You can use this output as part of a message to a chat channel in a step further along the flow. |
|
Status status |
The status that was assigned to the incident. |
|
Updated updated_at |
The date and time the incident was posted to the page. |