> For the complete documentation index, see [llms.txt](https://docs.groundcover.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.groundcover.com/automate/connected-apps/incident.io.md).

# incident.io

{% hint style="info" %}
This capability is only available to BYOC deployments. Check out our [pricing page](https://www.groundcover.com/pricing) for more information about subscription plans and the available deployment modes.
{% endhint %}

### **Create an Alert Source in incident.io**

1. **Generate an Alerts configuration for groundcover**\
   Log in to your incident.io account. Go to "Alerts" -> "Configure"

<figure><img src="https://2771001740-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUHgqKYgCiRKdOpWQdi52%2Fuploads%2FrfuFsatx5nS5G9bly78O%2Fimage.png?alt=media&amp;token=8c896412-7d11-484b-af17-efa3a3efb7ee" alt=""><figcaption></figcaption></figure>

2. Click on + "Add Alert Source"

<figure><img src="https://2771001740-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUHgqKYgCiRKdOpWQdi52%2Fuploads%2FHWf0oJATiCB6aiynJ2P7%2Fimage.png?alt=media&amp;token=04dc99ea-0ebd-4844-8ea7-d26ebeadf349" alt=""><figcaption></figcaption></figure>

3. **On the alert source screen of the configuration** the answer to the question "Where do your alerts come from?" should be "HTTP". Select this source and give it a unique name (e.g. groundcover). Hit "continue".
4. **incident.io will create your configuration now**, make sure to copy the Query authentication URL which you will need to use in the following steps in groundcover.

<figure><img src="https://2771001740-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUHgqKYgCiRKdOpWQdi52%2Fuploads%2FUjC6UO5oD2iP49dI0HSH%2Fimage.png?alt=media&amp;token=45a59eb6-2167-4506-a5c0-1a02832c05c9" alt=""><figcaption></figcaption></figure>

5. (Optional) It's recommended to configure the Destination now in groundcover and wait with the completion on incident.io until an Alert has been sent so that incident.io can easily parse the attributes as they are received (this step can be reconfigured after creation as well).

### Create an incident.io Destination in groundcover

1. Go to: **Integrations → Destinations**
2. Click on incident.io

<figure><img src="https://2771001740-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUHgqKYgCiRKdOpWQdi52%2Fuploads%2FGTBHN3L6yJGGTVoqglWZ%2Fimage.png?alt=media&amp;token=28335f17-f58d-4c16-b34b-b3b3d63ad4f4" alt="" width="306"><figcaption></figcaption></figure>

3. Select a name and paste the Alert Events URL (with the authentication inside)
4. (Optional) Add mapping for severity types, from groundcover to the custom severity types used in incident.io

<figure><img src="https://2771001740-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUHgqKYgCiRKdOpWQdi52%2Fuploads%2FWEW7ANHMmQ2wRkeYAjA2%2Fimage.png?alt=media&amp;token=47ea245b-4b8f-4c3c-b8e2-0585cb299aa2" alt="" width="375"><figcaption></figcaption></figure>

5. **Test the connection** (Optional)
   * This will send a notification similar to the notification that will be sent by monitors with `[TEST] Notification from groundcover` in the title to differentiate from 'real' notifications.
6. **Save**

### Controlling Auto-Resolution

By default, groundcover sends both "firing" and "resolved" states to incident.io, which auto-resolves alerts when monitors recover. If you want alerts to remain open until manually closed:

**Option 1: Configure Notification Routes (Recommended)**

1. Create a Notification Route with only "Firing" status (not "Resolved")
2. This prevents resolved notifications from being sent to incident.io

**Option 2: Configure incident.io** Configure your incident.io alert source to ignore resolved states or require manual resolution.

### Payload Structure

The payload sent to incident.io includes:

```json
{
  "title": "{{ summary }}",
  "description": "{{ description }}",
  "status": "firing|resolved",
  "deduplication_key": "{{ fingerprint }}",
  "source_url": "{{ urls.issue }}",
  "metadata": {
    "severity": "{{ severity }}",
    "monitor_name": "{{ monitor_name }}",
    "monitor_id": "{{ monitor_id }}",
    "value": "{{ value }}",
    "threshold": "{{ threshold }}",
    "renotification_count": 0,
    "labels": {
      "cluster": "{{ labels.cluster }}",
      "namespace": "{{ labels.namespace }}",
      "workload": "{{ labels.workload }}"
    }
  }
}
```

{% hint style="info" %}
This payload structure is fixed and cannot be customized. Values shown with `{{ }}` are dynamically populated from your monitor configuration. If you need a custom payload structure, use a [Generic Webhook](/automate/connected-apps/generic-webhook.md) instead.

**Test mode:** When using "Test the connection", the `status` field will be "test" and other fields like `value`, `threshold`, and URLs may contain placeholder values.
{% endhint %}

#### Payload Field Reference

| Field                  | Description                                                                                                                                       |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `title`                | Issue title from the alert                                                                                                                        |
| `description`          | Monitor description with variable expansion                                                                                                       |
| `status`               | Alert state: "firing", "resolved", or "test" (during connection testing)                                                                          |
| `deduplication_key`    | Alert fingerprint for grouping related alerts                                                                                                     |
| `source_url`           | Link to investigate the issue in groundcover                                                                                                      |
| `severity`             | Monitor severity (S1, S2, S3, S4) or custom mapped value configured in Destination settings                                                       |
| `monitor_name`         | Name of the monitor                                                                                                                               |
| `monitor_id`           | Internal unique ID of the monitor                                                                                                                 |
| `value`                | The value that triggered the alert                                                                                                                |
| `threshold`            | Configured threshold for the monitor                                                                                                              |
| `renotification_count` | Counter for re-notifications (starts at 0)                                                                                                        |
| `labels`               | Monitor labels as key-value pairs. Only labels defined in the monitor's group-by or custom labels are included; keys may be absent if not defined |

{% hint style="info" %}
**Migrating from Workflows?** incident.io Destinations use query authentication (token in URL), not bearer token authentication. The URL format should be the complete Alert Events URL provided by incident.io.
{% endhint %}


---

# 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.groundcover.com/automate/connected-apps/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.