> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/statuspage.md).

# Statuspage

Atlassian's hosted status-page service. Connect to declare and update incidents, schedule maintenance windows, manage component health, and manage subscribers for incident, maintenance, and component-health communication.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector  | Authentication |
| ---------- | -------------- |
| Statuspage | API Key        |

### Statuspage

Connect to Atlassian Statuspage to manage incidents, scheduled maintenance, components, and subscribers.

#### Set up in Statuspage

1. Prepare the Statuspage account or service that the workflow will access. Grant access to the required resources and operations.
2. Create or obtain the API credential identified in the fields below. Use the provider instructions linked with those fields to find its key-management page.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Statuspage**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                                                        |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| API Key       | Yes      | Statuspage has no OAuth flow, so this key is the only way to connect and it grants full access to every page in the account. Mint one at manage.statuspage.io: log in, open your avatar (bottom left), then "API info". [Provider instructions](https://manage.statuspage.io/login). |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Statuspage** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Status Pages

List the status pages this connection can manage, with the page ID each action needs.

#### Inputs

No input fields are required in this catalog entry.

#### Outputs

| Field | Type          | Description                                |
| ----- | ------------- | ------------------------------------------ |
| Pages | object\_array | The status pages this API key administers. |
| Count | integer       | How many pages were returned.              |

### List Components

See every component on a status page and its current health.

#### Inputs

| Field          | Type            | Required | Description                                                                                  |
| -------------- | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| Status page    | select (string) | Yes      | The status page whose components you want to see. Options load from the selected connection. |
| Max components | integer         | No       | Stop after this many components. Minimum: 1. Default: 100.                                   |
| Start page     | integer         | No       | Resume from a later page of results. Minimum: 1.                                             |

#### Outputs

| Field      | Type          | Description                                  |
| ---------- | ------------- | -------------------------------------------- |
| Components | object\_array | The components on the page.                  |
| Count      | integer       | How many components were returned.           |
| Next page  | integer       | Page number to pass back in to keep listing. |

### Create Component

Add a service to a status page so customers can see its health.

#### Inputs

| Field                   | Type            | Required | Description                                                                                                                                                     |
| ----------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Status page             | select (string) | Yes      | The status page to add the component to. Options load from the selected connection.                                                                             |
| Component name          | string          | Yes      | The service name customers will see, such as "API" or "Dashboard".                                                                                              |
| Description             | textarea        | No       | A short explanation of what this service covers.                                                                                                                |
| Initial status          | select (string) | No       | The health the component starts in. Available values: Operational, Degraded performance, Partial outage, Major outage, Under maintenance. Default: operational. |
| Show advanced fields    | boolean         | No       | Show grouping, visibility, and uptime start-date options. Default: false.                                                                                       |
| Component group         | select (string) | No       | Nest the component under an existing group. Options load from the selected connection.                                                                          |
| Show on the status page | boolean         | No       | Display this component publicly.                                                                                                                                |
| Only show when degraded | boolean         | No       | Hide the component while it is healthy.                                                                                                                         |
| Uptime start date       | date            | No       | The date uptime history should begin.                                                                                                                           |

#### Outputs

| Field        | Type   | Description                                 |
| ------------ | ------ | ------------------------------------------- |
| Component ID | string | Identifier of the new component.            |
| Name         | string | The component name.                         |
| Status       | string | The component's current health.             |
| Group ID     | string | The group the component belongs to, if any. |
| Created at   | string | When the component was created.             |

### Update Component Status

Change a component's health, for example from operational to major outage.

#### Inputs

| Field       | Type            | Required | Description                                                                                                                                     |
| ----------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| Status page | select (string) | Yes      | The status page the component belongs to. Options load from the selected connection.                                                            |
| Component   | select (string) | Yes      | The component whose health you want to change. Options load from the selected connection.                                                       |
| New status  | select (string) | Yes      | The health to publish for this component. Available values: Operational, Degraded performance, Partial outage, Major outage, Under maintenance. |

#### Outputs

| Field        | Type   | Description                              |
| ------------ | ------ | ---------------------------------------- |
| Component ID | string | Identifier of the updated component.     |
| Name         | string | The component name.                      |
| Status       | string | The component's health after the update. |
| Updated at   | string | When the change took effect.             |

### Create Incident

Declare an incident on your status page and tell customers what is going on.

#### Inputs

| Field                      | Type                      | Required | Description                                                                                                                                                                    |
| -------------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Status page                | select (string)           | Yes      | The status page to publish the incident on. Options load from the selected connection.                                                                                         |
| Incident title             | string                    | Yes      | A short headline customers will see, such as "Elevated API error rates".                                                                                                       |
| Incident status            | select (string)           | No       | Where the incident stands right now. Available values: Investigating, Identified, Monitoring, Resolved. Default: investigating.                                                |
| Update message             | textarea                  | No       | The first update customers read, explaining the impact and what you are doing.                                                                                                 |
| Affected components        | multiple\_select (string) | No       | The services this incident affects. Options load from the selected connection.                                                                                                 |
| Set affected components to | select (string)           | No       | Optionally flip the health of every affected component in the same step. Available values: Operational, Degraded performance, Partial outage, Major outage, Under maintenance. |
| Show advanced fields       | boolean                   | No       | Show impact override and notification options. Default: false.                                                                                                                 |
| Impact                     | select (string)           | No       | Override the severity Statuspage would calculate from the affected components. Available values: None, Minor, Major, Critical.                                                 |
| Notify subscribers         | boolean                   | No       | Email and text your subscribers about this incident.                                                                                                                           |

#### Outputs

| Field       | Type   | Description                        |
| ----------- | ------ | ---------------------------------- |
| Incident ID | string | Identifier of the new incident.    |
| Title       | string | The incident headline.             |
| Status      | string | Where the incident stands.         |
| Impact      | string | The severity shown to customers.   |
| Public link | string | Short public URL for the incident. |
| Created at  | string | When the incident was opened.      |

### Update Incident

Post a progress update on an open incident and move it to the next stage.

#### Inputs

| Field                      | Type                      | Required | Description                                                                                                                                                                                                                                            |
| -------------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Status page                | select (string)           | Yes      | The status page the incident lives on. Options load from the selected connection.                                                                                                                                                                      |
| Incident                   | select (string)           | Yes      | The open incident you want to update. Options load from the selected connection.                                                                                                                                                                       |
| Update message             | textarea                  | No       | What you want to tell customers now.                                                                                                                                                                                                                   |
| Incident status            | string                    | No       | Move the incident to a new stage. Available values: Investigating (realtime), Identified (realtime), Monitoring (realtime), Resolved (realtime), Scheduled (maintenance), In progress (maintenance), Verifying (maintenance), Completed (maintenance). |
| Affected components        | multiple\_select (string) | No       | Replace the list of services this incident affects. Options load from the selected connection.                                                                                                                                                         |
| Set affected components to | select (string)           | No       | Optionally flip the health of every affected component in the same step. Available values: Operational, Degraded performance, Partial outage, Major outage, Under maintenance.                                                                         |
| Show advanced fields       | boolean                   | No       | Show impact override and notification options. Default: false.                                                                                                                                                                                         |
| Impact                     | select (string)           | No       | Override the severity Statuspage would calculate. Available values: None, Minor, Major, Critical, Maintenance.                                                                                                                                         |
| Notify subscribers         | boolean                   | No       | Email and text your subscribers about this update.                                                                                                                                                                                                     |

#### Outputs

| Field       | Type   | Description                                 |
| ----------- | ------ | ------------------------------------------- |
| Incident ID | string | Identifier of the incident.                 |
| Title       | string | The incident headline.                      |
| Status      | string | Where the incident stands after the update. |
| Impact      | string | The severity shown to customers.            |
| Public link | string | Short public URL for the incident.          |
| Updated at  | string | When the update was published.              |

### Resolve Incident

Close out an incident with a final message and put the affected services back to operational.

#### Inputs

| Field                                       | Type            | Required | Description                                                                       |
| ------------------------------------------- | --------------- | -------- | --------------------------------------------------------------------------------- |
| Status page                                 | select (string) | Yes      | The status page the incident lives on. Options load from the selected connection. |
| Incident                                    | select (string) | Yes      | The open incident to close. Options load from the selected connection.            |
| Resolution message                          | textarea        | No       | The final update customers read, saying the issue is fixed.                       |
| Set affected components back to operational | boolean         | No       | Return every service this incident affected to healthy. Default: true.            |
| Show advanced fields                        | boolean         | No       | Show notification options. Default: false.                                        |
| Notify subscribers                          | boolean         | No       | Email and text your subscribers that the incident is resolved.                    |

#### Outputs

| Field               | Type          | Description                           |
| ------------------- | ------------- | ------------------------------------- |
| Incident ID         | string        | Identifier of the resolved incident.  |
| Title               | string        | The incident headline.                |
| Status              | string        | The incident status, now resolved.    |
| Resolved at         | string        | When the incident was closed.         |
| Restored components | string\_array | The services set back to operational. |
| Public link         | string        | Short public URL for the incident.    |

### List Incidents

Look up incidents on a status page, filtered to the ones you care about.

#### Inputs

| Field           | Type            | Required | Description                                                                                                                                                                             |
| --------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Status page     | select (string) | Yes      | The status page whose incidents you want. Options load from the selected connection.                                                                                                    |
| Which incidents | select (string) | No       | Narrow to open incidents, planned maintenance, or the full history. Available values: Unresolved, All (full history), Scheduled maintenance, Upcoming maintenance. Default: unresolved. |
| Search text     | string          | No       | Only keep incidents whose title or body contains this text.                                                                                                                             |
| Max incidents   | integer         | No       | Stop after this many incidents. Minimum: 1. Default: 100.                                                                                                                               |
| Start page      | integer         | No       | Resume from a later page of results. Minimum: 1.                                                                                                                                        |

#### Outputs

| Field     | Type          | Description                                  |
| --------- | ------------- | -------------------------------------------- |
| Incidents | object\_array | The incidents that matched.                  |
| Count     | integer       | How many incidents were returned.            |
| Next page | integer       | Page number to pass back in to keep listing. |

### Create Scheduled Maintenance

Announce a planned maintenance window and let Statuspage start and finish it for you.

#### Inputs

| Field                             | Type                      | Required | Description                                                                                                                                                              |
| --------------------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Status page                       | select (string)           | Yes      | The status page to announce the maintenance on. Options load from the selected connection.                                                                               |
| Maintenance title                 | string                    | Yes      | A short headline, such as "Scheduled database upgrade".                                                                                                                  |
| Description                       | textarea                  | No       | What customers should expect during the window.                                                                                                                          |
| Starts at                         | datetime                  | Yes      | When the maintenance window begins.                                                                                                                                      |
| Ends at                           | datetime                  | Yes      | When the maintenance window ends.                                                                                                                                        |
| Affected components               | multiple\_select (string) | No       | The services the maintenance affects. Options load from the selected connection.                                                                                         |
| Start and finish automatically    | boolean                   | No       | Let Statuspage move the maintenance to in progress and then completed on schedule. Default: true.                                                                        |
| Mark components under maintenance | boolean                   | No       | Show the affected services as under maintenance while the window is open, then healthy again after. Only takes effect when components are selected above. Default: true. |
| Show advanced fields              | boolean                   | No       | Show reminder and notification options. Default: false.                                                                                                                  |
| Send a reminder beforehand        | boolean                   | No       | Remind subscribers shortly before the window starts.                                                                                                                     |
| Notify subscribers                | boolean                   | No       | Email and text your subscribers about the planned maintenance.                                                                                                           |

#### Outputs

| Field          | Type   | Description                              |
| -------------- | ------ | ---------------------------------------- |
| Maintenance ID | string | Identifier of the scheduled maintenance. |
| Title          | string | The maintenance headline.                |
| Status         | string | Where the maintenance stands.            |
| Starts at      | string | When the window begins.                  |
| Ends at        | string | When the window ends.                    |
| Public link    | string | Short public URL for the maintenance.    |

### List Subscribers

See who is subscribed to updates from a status page.

#### Inputs

| Field           | Type            | Required | Description                                                                                                                               |
| --------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Status page     | select (string) | Yes      | The status page whose subscribers you want. Options load from the selected connection.                                                    |
| Channel         | select (string) | No       | Only show subscribers on one channel. Available values: Email, SMS, Webhook, Slack, Integration partner.                                  |
| State           | select (string) | No       | Filter by whether the subscription is confirmed and delivering. Available values: Active, Unconfirmed, Quarantined, All. Default: active. |
| Search text     | string          | No       | Match against the subscriber's email, phone number, or endpoint.                                                                          |
| Max subscribers | integer         | No       | Stop after this many subscribers. Minimum: 1. Default: 100.                                                                               |
| Start page      | integer         | No       | Resume from a later page of results. Minimum: 1.                                                                                          |

#### Outputs

| Field       | Type          | Description                                  |
| ----------- | ------------- | -------------------------------------------- |
| Subscribers | object\_array | The subscribers that matched.                |
| Count       | integer       | How many subscribers were returned.          |
| Next page   | integer       | Page number to pass back in to keep listing. |

### Add Subscriber

Subscribe an email address, phone number, or webhook endpoint to a status page.

#### Inputs

| Field                         | Type                      | Required | Description                                                                                            |
| ----------------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| Status page                   | select (string)           | Yes      | The status page to subscribe to. Options load from the selected connection.                            |
| Channel                       | select (string)           | Yes      | How this subscriber should be notified. Available values: Email, SMS, Webhook. Default: email.         |
| Email address                 | string                    | No       | Where email updates are sent.                                                                          |
| Phone number                  | string                    | No       | Where text updates are sent.                                                                           |
| Phone country                 | string                    | No       | Two-letter country code for the phone number. Default: us.                                             |
| Webhook URL                   | string                    | No       | The HTTPS endpoint Statuspage should POST events to.                                                   |
| Components to follow          | multiple\_select (string) | No       | Only notify about these services instead of the whole page. Options load from the selected connection. |
| Skip the confirmation message | boolean                   | No       | Activate the subscription without asking the recipient to confirm. Default: false.                     |

#### Outputs

| Field         | Type   | Description                                |
| ------------- | ------ | ------------------------------------------ |
| Subscriber ID | string | Identifier of the new subscriber.          |
| Channel       | string | The channel the subscriber was added on.   |
| Email address | string | The subscriber's email, if any.            |
| Webhook URL   | string | The subscriber's webhook endpoint, if any. |
| Created at    | string | When the subscription was created.         |

### Remove Subscriber

Unsubscribe someone from a status page's notifications.

#### Inputs

| Field                            | Type            | Required | Description                                                                                                |
| -------------------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------- |
| Status page                      | select (string) | Yes      | The status page the subscriber belongs to. Options load from the selected connection.                      |
| Subscriber                       | select (string) | Yes      | The subscriber to unsubscribe. This cannot be undone from here. Options load from the selected connection. |
| Tell them they were unsubscribed | boolean         | No       | Send the recipient Statuspage's standard unsubscribe confirmation. Default: true.                          |

#### Outputs

| Field         | Type   | Description                                        |
| ------------- | ------ | -------------------------------------------------- |
| Subscriber ID | string | Identifier of the removed subscriber.              |
| Channel       | string | The channel the subscriber was on.                 |
| Email address | string | The removed subscriber's email, if any.            |
| Webhook URL   | string | The removed subscriber's webhook endpoint, if any. |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### On Incident Created or Updated

Polls a status page's incidents and fires once per incident update posted since the last poll (or once per new incident), carrying that update's text.

Pick the status page to watch. Leave 'Only when an incident is created' off to fire on both new incidents and every later update; turn it on to fire only when an incident first opens. Each Statuspage API token is limited to 1 request per second, measured on a rolling 60-second window; exceeding it returns HTTP 420 or 429.

#### Configuration

| Field                            | Type            | Required | Description                                                                      |
| -------------------------------- | --------------- | -------- | -------------------------------------------------------------------------------- |
| Status page                      | select (string) | Yes      | The status page to watch. Options load from the selected connection.             |
| Only when an incident is created | boolean         | No       | Ignore progress updates and fire only when a new incident opens. Default: false. |

#### Event inputs

| Field               | Type   | Required | Description                                         |
| ------------------- | ------ | -------- | --------------------------------------------------- |
| Incident ID         | string | Yes      | Identifier of the incident. Default: .              |
| Title               | string | Yes      | The incident headline. Default: .                   |
| Status              | string | Yes      | Where the incident stands. Default: .               |
| Impact              | string | Yes      | The severity shown to customers. Default: .         |
| Latest update       | string | No       | The update message that fired this event.           |
| Affected components | array  | Yes      | The services the incident affects. Default: \[].    |
| Public link         | string | No       | Short public URL for the incident.                  |
| Created at          | string | Yes      | When the incident was opened. Default: .            |
| Updated at          | string | Yes      | When this change happened. Default: .               |
| Status page ID      | string | Yes      | The status page the incident belongs to. Default: . |

#### Outputs

| Field               | Type          | Description                               |
| ------------------- | ------------- | ----------------------------------------- |
| Incident ID         | string        | Identifier of the incident.               |
| Title               | string        | The incident headline.                    |
| Status              | string        | Where the incident stands.                |
| Impact              | string        | The severity shown to customers.          |
| Latest update       | string        | The update message that fired this event. |
| Affected components | string\_array | The services the incident affects.        |
| Public link         | string        | Short public URL for the incident.        |
| Created at          | string        | When the incident was opened.             |
| Updated at          | string        | When this change happened.                |
| Status page ID      | string        | The status page the incident belongs to.  |

### On Component Status Changed

Polls a status page's components and fires only when a component's status differs from the value seen on the previous poll, carrying both the old and the new status. A component's updated\_at bumps on any edit (rename, reposition, description), so it cannot discriminate a real status change on its own.

Pick the status page to watch, and optionally narrow to specific components. Leave 'Components to watch' empty to fire for any component on the page. Each Statuspage API token is limited to 1 request per second, measured on a rolling 60-second window; exceeding it returns HTTP 420 or 429.

#### Configuration

| Field               | Type                      | Required | Description                                                                                                     |
| ------------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| Status page         | select (string)           | Yes      | The status page to watch. Options load from the selected connection.                                            |
| Components to watch | multiple\_select (string) | No       | Only fire for these services instead of every component on the page. Options load from the selected connection. |

#### Event inputs

| Field           | Type   | Required | Description                                          |
| --------------- | ------ | -------- | ---------------------------------------------------- |
| Component ID    | string | Yes      | Identifier of the component. Default: .              |
| Name            | string | Yes      | The component name. Default: .                       |
| New status      | string | Yes      | The health the component just moved to. Default: .   |
| Previous status | string | No       | The health the component had before.                 |
| Group ID        | string | No       | The group the component belongs to, if any.          |
| Updated at      | string | Yes      | When the component last changed. Default: .          |
| Status page ID  | string | Yes      | The status page the component belongs to. Default: . |

#### Outputs

| Field           | Type   | Description                                 |
| --------------- | ------ | ------------------------------------------- |
| Component ID    | string | Identifier of the component.                |
| Name            | string | The component name.                         |
| New status      | string | The health the component just moved to.     |
| Previous status | string | The health the component had before.        |
| Group ID        | string | The group the component belongs to, if any. |
| Updated at      | string | When the component last changed.            |
| Status page ID  | string | The status page the component belongs to.   |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/statuspage.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
