> 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/incident.io.md).

# incident.io

Declare and update incidents, push alerts, page on-call responders, and open post-incident follow-ups in incident.io.

### Connectors

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

| Connector   | Authentication |
| ----------- | -------------- |
| incident.io | API Key        |

#### incident.io

Connect to incident.io to declare and update incidents, push alerts, page on-call responders, and open post-incident follow-ups.

**Set up in incident.io**

1. Prepare the incident.io account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create an API key under Settings > API keys in the incident.io dashboard. Tick the permission bundles you need: 'View data' for the read actions, 'Create and manage incidents' to declare and edit incidents, 'Create escalations' to page responders. Bundles are fixed at creation time and cannot be changed later.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **incident.io**.
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      | Create an API key under Settings > API keys in the incident.io dashboard. Tick the permission bundles you need: 'View data' for the read actions, 'Create and manage incidents' to declare and edit incidents, 'Create escalations' to page responders. Bundles are fixed at creation time and cannot be changed later. [Provider instructions](https://app.incident.io/settings/api-keys). |

#### 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 **incident.io** 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

#### Create Incident

Declare a new incident in incident.io.

**Inputs**

| Field           | Type            | Required | Description                                                                                                                     |
| --------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Incident name   | string          | Yes      | A short name for the incident.                                                                                                  |
| Summary         | textarea        | No       | What is happening, for the responders who join.                                                                                 |
| Severity        | select (string) | No       | How severe the incident is. Options load from the selected connection.                                                          |
| Incident type   | select (string) | No       | Which incident type to declare under. Options load from the selected connection.                                                |
| Starting status | select (string) | No       | Status to open the incident in. Options load from the selected connection.                                                      |
| Visibility      | select (string) | Yes      | Whether everyone in the organisation can see this incident. Available values: Public, Private. Default: public.                 |
| Mode            | select (string) | No       | Declare a real incident, a retrospective record, or a test. Available values: Standard, Retrospective, Test. Default: standard. |
| Idempotency key | string          | Yes      | A unique key for this operation. Reuse it only for retries.                                                                     |

**Outputs**

| Field       | Type   | Description                                            |
| ----------- | ------ | ------------------------------------------------------ |
| Incident    | object | The incident that was declared.                        |
| Incident ID | string | ID of the new incident.                                |
| Reference   | string | The human-readable incident reference, such as INC-42. |
| Link        | string | Link to the incident in incident.io.                   |

#### List Incidents

List and filter incidents.

**Inputs**

| Field           | Type                      | Required | Description                                                                                                                                                 |
| --------------- | ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Stage           | multiple\_select (string) | No       | Only show incidents at these stages of their lifecycle. Available values: Triage, Live, Learning, Closed, Paused, Declined, Merged, Canceled. Default: \[]. |
| Statuses        | multiple\_select (string) | No       | Only show incidents in these exact statuses. Options load from the selected connection. Default: \[].                                                       |
| Severities      | multiple\_select (string) | No       | Only show incidents at these severities. Options load from the selected connection. Default: \[].                                                           |
| Order           | select (string)           | No       | Which end of the list to start from. Available values: Newest first, Oldest first. Default: created\_at\_newest\_first.                                     |
| Maximum results | integer                   | No       | How many incidents to return at most. Minimum: 1. Default: 25.                                                                                              |
| Continue from   | string                    | No       | Resume a previous listing instead of starting over.                                                                                                         |

**Outputs**

| Field       | Type          | Description                                             |
| ----------- | ------------- | ------------------------------------------------------- |
| Incidents   | object\_array | The matching incidents.                                 |
| Count       | integer       | How many incidents were returned.                       |
| Next cursor | string        | Pass this back as 'Continue from' to get the next page. |

#### Get Incident

Get one incident's full detail.

**Inputs**

| Field    | Type            | Required | Description                                                        |
| -------- | --------------- | -------- | ------------------------------------------------------------------ |
| Incident | select (string) | Yes      | Which incident to read. Options load from the selected connection. |

**Outputs**

| Field       | Type   | Description                                             |
| ----------- | ------ | ------------------------------------------------------- |
| Incident    | object | The incident, with its status, severity and timestamps. |
| Incident ID | string | ID of the incident.                                     |
| Name        | string | The incident's name.                                    |
| Summary     | string | The incident's summary.                                 |
| Status      | string | The incident's current status.                          |
| Severity    | string | The incident's current severity.                        |
| Link        | string | Link to the incident in incident.io.                    |

#### Update Incident

Update an incident's severity, status or details.

**Inputs**

| Field                                   | Type            | Required | Description                                                                         |
| --------------------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------- |
| Incident                                | select (string) | Yes      | Which incident to update. Options load from the selected connection.                |
| New severity                            | select (string) | No       | Escalate or downgrade the severity. Options load from the selected connection.      |
| New status                              | select (string) | No       | Move the incident to a different status. Options load from the selected connection. |
| New name                                | string          | No       | Rename the incident.                                                                |
| New summary                             | textarea        | No       | Replace the incident summary.                                                       |
| Custom fields                           | object\_array   | No       | Set custom-field values or clear a specific field.                                  |
| Post the change to the incident channel | boolean         | No       | Tell the responders in Slack that this changed. Default: true.                      |

**Outputs**

| Field       | Type   | Description                               |
| ----------- | ------ | ----------------------------------------- |
| Incident    | object | The incident after the update.            |
| Incident ID | string | ID of the updated incident.               |
| Status      | string | The incident's status after the update.   |
| Severity    | string | The incident's severity after the update. |

#### Create Alert Event

Send an alert into incident.io.

**Inputs**

| Field              | Type            | Required | Description                                                                                             |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------- |
| Alert source       | select (string) | Yes      | Which alert source this alert arrives through. Options load from the selected connection.               |
| Title              | string          | Yes      | One line describing what fired.                                                                         |
| Status             | select (string) | Yes      | Whether the condition is happening or has cleared. Available values: Firing, Resolved. Default: firing. |
| Description        | textarea        | No       | More detail for whoever picks this up.                                                                  |
| Deduplication key  | string          | Yes      | Repeat alerts sharing this key update one alert, not many.                                              |
| Source link        | string          | No       | Link back to the dashboard or monitor that fired.                                                       |
| Metadata           | object          | No       | Extra fields your alert source is configured to read.                                                   |
| Alert source token | secret          | No       | Override the source's token if it cannot be read automatically.                                         |

**Outputs**

| Field             | Type   | Description                             |
| ----------------- | ------ | --------------------------------------- |
| Status            | string | Whether incident.io accepted the alert. |
| Message           | string | What incident.io said about the alert.  |
| Deduplication key | string | The key this alert was recorded under.  |

#### List Alerts

List alerts received by incident.io.

**Inputs**

| Field           | Type                      | Required | Description                                                                                                   |
| --------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Statuses        | multiple\_select (string) | No       | Only show alerts in these states. Available values: Firing, Resolved. Default: \[].                           |
| Alert sources   | multiple\_select (string) | No       | Only show alerts that arrived through these sources. Options load from the selected connection. Default: \[]. |
| Maximum results | integer                   | No       | How many alerts to return at most. Minimum: 1. Default: 25.                                                   |
| Continue from   | string                    | No       | Resume a previous listing instead of starting over.                                                           |

**Outputs**

| Field       | Type          | Description                                             |
| ----------- | ------------- | ------------------------------------------------------- |
| Alerts      | object\_array | The matching alerts.                                    |
| Count       | integer       | How many alerts were returned.                          |
| Next cursor | string        | Pass this back as 'Continue from' to get the next page. |

#### Create Follow-up

Create a post-incident follow-up.

**Inputs**

| Field       | Type            | Required | Description                                                                          |
| ----------- | --------------- | -------- | ------------------------------------------------------------------------------------ |
| Incident    | select (string) | Yes      | Which incident this follow-up belongs to. Options load from the selected connection. |
| Title       | string          | Yes      | The action item, in one line.                                                        |
| Description | textarea        | No       | Why this matters, for whoever picks it up.                                           |
| Assignee    | select (string) | No       | Who should pick this up. Options load from the selected connection.                  |

**Outputs**

| Field        | Type   | Description                     |
| ------------ | ------ | ------------------------------- |
| Follow-up    | object | The follow-up that was created. |
| Follow-up ID | string | ID of the new follow-up.        |
| Status       | string | The follow-up's status.         |

#### Create Escalation

Page an on-call responder through incident.io.

**Inputs**

| Field            | Type                      | Required | Description                                                                                                     |
| ---------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| Title            | string                    | Yes      | What the responder sees when they are paged.                                                                    |
| Description      | textarea                  | No       | Extra detail for the responder.                                                                                 |
| Escalation path  | select (string)           | No       | Which on-call rota to page. Options load from the selected connection.                                          |
| Users            | multiple\_select (string) | No       | Page these people directly instead of an on-call rota. Options load from the selected connection. Default: \[]. |
| Related incident | select (string)           | No       | Link the page to an existing incident. Options load from the selected connection.                               |
| Idempotency key  | string                    | Yes      | A unique key for this operation. Reuse it only for retries.                                                     |

**Outputs**

| Field         | Type   | Description                      |
| ------------- | ------ | -------------------------------- |
| Escalation    | object | The escalation that was created. |
| Escalation ID | string | ID of the new escalation.        |
| Status        | string | Where the page has got 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/incident.io.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.
