> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# incident.io

> How to set up the incident.io connector, plus the actions that are available.

![incident.io](https://stackone-logos.com/api/incident/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/incident/changelog.md)

[174 actions](#actions) · 1 auth method

Observability

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/incident/guides/connector-profile/api-key.md)
>
> No app registration required. The key's roles are fixed when it is created in the incident.io dashboard and cannot be ch...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/incident/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

174 actions

ActionDescription

List Actions`incident_list_actions`

List actions for an organisation.

Get Action`incident_get_action`

Get a single incident action.

Create Action`incident_create_action`

Create a new incident action.

Update Action`incident_update_action`

Update an existing incident action.

Delete Action`incident_delete_action`

Delete an incident action.

List Alert Attributes`incident_list_alert_attributes`

List alert attributes.

Get Alert Attribute`incident_get_alert_attribute`

Show an alert attribute.

Create Alert Attribute`incident_create_alert_attribute`

Create a new alert attribute.

Update Alert Attribute`incident_update_alert_attribute`

Update an alert attribute.

Delete Alert Attribute`incident_delete_alert_attribute`

Destroy an alert attribute.

Create Alert Event`incident_create_alert_event`

Create an alert event using an HTTP source.

List Alert Notes`incident_list_alert_notes`

List alert notes attached to an alert.

Get Alert Note`incident_get_alert_note`

Get a single alert note.

Create Alert Note`incident_create_alert_note`

Add a note to an alert.

Update Alert Note`incident_update_alert_note`

Replace the content of an alert note.

Delete Alert Note`incident_delete_alert_note`

Delete an alert note.

List Alert Routes`incident_list_alert_routes`

List all alert routes in your account.

Get Alert Route`incident_get_alert_route`

Load details about a specific alert route in your account.

Create Alert Route`incident_create_alert_route`

Create a new alert route in your account.

Update Alert Route`incident_update_alert_route`

Update an existing alert route in your account.

Delete Alert Route`incident_delete_alert_route`

Delete an existing alert route in your account.

List Alert Sources`incident_list_alert_sources`

List all alert sources in your account.

Get Alert Source`incident_get_alert_source`

Load details about a specific alert source in your account.

Create Alert Source`incident_create_alert_source`

Create a new alert source in your account.

Update Alert Source`incident_update_alert_source`

Update an existing alert source in your account.

Delete Alert Source`incident_delete_alert_source`

Delete an existing alert source in your account.

Validate Alert Source`incident_validate_alert_source`

Check whether an alert source template is valid, without creating or updating anything.

List Alert Tags`incident_list_alert_tags`

List the alert tags in your organisation's vocabulary.

List Alerts`incident_list_alerts`

List all alerts for your account.

List Incident Alerts`incident_list_incident_alerts`

List the connections between incidents and alerts

Get Alert`incident_get_alert`

Show a single alert for your account

Create Incident Alert`incident_create_incident_alert`

Attach an alert to an incident, creating the connection between them.

Add Alert Tags`incident_add_alert_tags`

Add tags to an alert without changing its existing tags.

Remove Alert Tags`incident_remove_alert_tags`

Remove tags from an alert without changing its other tags.

Resolve Alert`incident_resolve_alert`

Resolve a currently firing alert.

Set Alert Tags`incident_set_alert_tags`

Replace all tags on an alert.

Transition Incident Alert`incident_transition_incident_alert`

Confirm or detach the connection between an alert and an incident.

List Catalog Entries`incident_list_catalog_entries`

List entries for a catalog type.

List Catalog Resources`incident_list_catalog_resources`

List available engine resources for the catalog.

List Catalog Types`incident_list_catalog_types`

List all catalog types for an organisation, including those synced from external resources.

Get Catalog Entry`incident_get_catalog_entry`

Show a single catalog entry.

Get Catalog Type`incident_get_catalog_type`

Show a single catalog type.

Create Catalog Entry`incident_create_catalog_entry`

Create an entry within the catalog.

Create Catalog Type`incident_create_catalog_type`

Create a catalog type.

Update Catalog Entry`incident_update_catalog_entry`

Updates an existing catalog entry.

Update Catalog Type`incident_update_catalog_type`

Updates an existing catalog type.

Update Catalog Type Schema`incident_update_catalog_type_schema`

Update an existing catalog types schema, adding or removing attributes.

Delete Catalog Entry`incident_delete_catalog_entry`

Archives a catalog entry.

Delete Catalog Type`incident_delete_catalog_type`

Archives a catalog type and associated entries.

Bulk Update Catalog Entries`incident_bulk_update_catalog_entries`

Update multiple catalog entries in a single operation.

List Custom Field Options`incident_list_custom_field_options`

Show custom field options for a custom field

Get Custom Field Option`incident_get_custom_field_option`

Get a single custom field option

Create Custom Field Option`incident_create_custom_field_option`

Create a custom field option.

Update Custom Field Option`incident_update_custom_field_option`

Update a custom field option

Delete Custom Field Option`incident_delete_custom_field_option`

Delete a custom field option

List Custom Fields`incident_list_custom_fields`

List all custom fields for an organisation.

Get Custom Field`incident_get_custom_field`

Get a single custom field.

Create Custom Field`incident_create_custom_field`

Create a new custom field

Update Custom Field`incident_update_custom_field`

Update the details of a custom field

Delete Custom Field`incident_delete_custom_field`

Delete a custom field

List Escalation Path Templates`incident_list_escalation_path_templates`

List active escalation path templates.

Get Escalation Path Template`incident_get_escalation_path_template`

Show a particular escalation path template.

Create Escalation Path Template`incident_create_escalation_path_template`

Create a new escalation path template.

Update Escalation Path Template`incident_update_escalation_path_template`

Update a particular escalation path template.

Delete Escalation Path Template`incident_delete_escalation_path_template`

Archives a particular escalation path template.

List Escalation Paths`incident_list_escalation_paths`

List all escalation paths in your account.

List Escalations`incident_list_escalations`

List all escalations for your account.

Get Escalation`incident_get_escalation`

Show a specific escalation.

Get Escalation Path`incident_get_escalation_path`

Show an escalation path.

Create Escalation`incident_create_escalation`

Create an escalation.

Create Escalation Path`incident_create_escalation_path`

Create an escalation path.

Update Escalation Path`incident_update_escalation_path`

Updates an escalation path.

Delete Escalation Path`incident_delete_escalation_path`

Archives an escalation path.

Cancel Escalation`incident_cancel_escalation`

Cancel an escalation.

Check Escalation Permissions`incident_check_escalation_permissions`

Check whether the given users can currently acknowledge, decline, or snooze an escalation.

Reassign Escalation`incident_reassign_escalation`

Reassign an escalation to a different escalation path or set of users.

Respond Escalation`incident_respond_escalation`

Respond to an escalation.

List Follow Ups`incident_list_follow_ups`

List follow-ups for an organisation.

Get Follow Up`incident_get_follow_up`

Get a single incident follow-up.

Create Follow Up`incident_create_follow_up`

Create a new incident follow-up.

Create Follow Up From Link`incident_create_follow_up_from_link`

Create a follow-up from the URL of an issue that already exists in an issue tracker.

Update Follow Up`incident_update_follow_up`

Update an existing incident follow-up.

Delete Follow Up`incident_delete_follow_up`

Delete an incident follow-up.

Connect Follow Up External Issue`incident_connect_follow_up_external_issue`

Connect a follow-up to an existing issue in an issue tracker, using the URL of the issue.

List Incident Attachments`incident_list_incident_attachments`

List all incident attachments for a given external resource or incident.

Create Incident Attachment`incident_create_incident_attachment`

Attaches an external resource to an incident.

Delete Incident Attachment`incident_delete_incident_attachment`

Unattaches an external resource from an incident

Create Incident Membership`incident_create_incident_membership`

Makes a user a member of a private incident

Revoke Incident Membership`incident_revoke_incident_membership`

Revoke a user's membership of a private incident

List Incident Roles`incident_list_incident_roles`

List all incident roles for an organisation.

Get Incident Role`incident_get_incident_role`

Get a single incident role.

Create Incident Role`incident_create_incident_role`

Create a new incident role

Update Incident Role`incident_update_incident_role`

Update an existing incident role

Delete Incident Role`incident_delete_incident_role`

Removes an existing role

List Incident Statuses`incident_list_incident_statuses`

List all incident statuses for an organisation.

Get Incident Status`incident_get_incident_status`

Get a single incident status.

Create Incident Status`incident_create_incident_status`

Create a new incident status

Update Incident Status`incident_update_incident_status`

Update an existing incident status

Delete Incident Status`incident_delete_incident_status`

Delete an incident status

List Incident Timeline Items`incident_list_incident_timeline_items`

List the timeline items for an incident, oldest first.

Create Incident Timeline Item`incident_create_incident_timeline_item`

Add a custom item to an incident's timeline.

Update Incident Timeline Item`incident_update_incident_timeline_item`

Edit a timeline item.

List Incident Timestamps`incident_list_incident_timestamps`

List all incident timestamps for an organisation.

Get Incident Timestamp`incident_get_incident_timestamp`

Get a single incident timestamp.

List Incident Types`incident_list_incident_types`

List all incident types for an organisation.

Get Incident Type`incident_get_incident_type`

Get a single incident type.

List Incident Updates`incident_list_incident_updates`

List all incident updates for an organisation, or for a specific incident.

Create Incident Update`incident_create_incident_update`

Share an update against an incident.

List Incidents`incident_list_incidents`

List all incidents for an organisation.

Get Incident`incident_get_incident`

Get a single incident.

Create Incident`incident_create_incident`

Create a new incident.

Edit Incident`incident_edit_incident`

Edit an existing incident.

Import Incident Postmortem Document`incident_import_incident_postmortem_document`

Import a postmortem document from markdown into an incident.

List Postmortem Documents`incident_list_postmortem_documents`

List post-mortem documents for the organisation.

Get Postmortem Document Content`incident_get_postmortem_document_content`

Fetch the content of a post-mortem document, rendered as markdown.

Get Postmortem Document`incident_get_postmortem_document`

Get a single post-mortem document by ID.

Update Postmortem Document Status`incident_update_postmortem_document_status`

Update the status of a post-mortem document.

Attach Postmortem Document`incident_attach_postmortem_document`

Link an externally-hosted post-mortem document to an incident.

List Schedule Replicas`incident_list_schedule_replicas`

List all replicas for a schedule.

List Schedule Entries`incident_list_schedule_entries`

List the schedule entries for a schedule over a window of time.

List Schedule Overrides`incident_list_schedule_overrides`

List the overrides on a schedule.

List Schedules`incident_list_schedules`

List configured schedules.

List Schedule Sync Rules`incident_list_schedule_sync_rules`

List the sync rules configured on this schedule.

Get Schedule Replica`incident_get_schedule_replica`

Get a single schedule replica.

Get Schedule`incident_get_schedule`

Get a single schedule.

Get Schedule Override`incident_get_schedule_override`

Get a single schedule override.

Get Schedule Sync Rule`incident_get_schedule_sync_rule`

Get a single sync rule for a schedule.

Create Schedule Replica`incident_create_schedule_replica`

Create a new schedule replica.

Create Schedule`incident_create_schedule`

Create a new schedule.

Create Schedule Override`incident_create_schedule_override`

Create a new schedule override.

Create Schedule Sync Rule`incident_create_schedule_sync_rule`

Create a new sync rule linking a schedule to a sync target.

Update Schedule`incident_update_schedule`

Update a schedule.

Update Schedule Override`incident_update_schedule_override`

Update a schedule override, moving its window or the rotation and layer it sits on.

Update Schedule Sync Rule`incident_update_schedule_sync_rule`

Update a sync rule's sync\_type and permanent members in place.

Delete Schedule Replica`incident_delete_schedule_replica`

Archives a single schedule replica, stopping incident.io from syncing on-call shifts to the external provider.

Delete Schedule`incident_delete_schedule`

Archives a single schedule.

Delete Schedule Override`incident_delete_schedule_override`

Delete a schedule override, restoring whoever the rotations put on-call for that window.

Delete Schedule Sync Rule`incident_delete_schedule_sync_rule`

Archive a sync rule, unlinking the schedule from the sync target.

Preview Schedule Entries`incident_preview_schedule_entries`

Preview the schedule entries that would be generated by a proposed schedule configuration.

List Severities`incident_list_severities`

List all incident severities for an organisation.

Get Severity`incident_get_severity`

Get a single incident severity.

Create Severity`incident_create_severity`

Create a new severity

Update Severity`incident_update_severity`

Update an existing severity

Delete Severity`incident_delete_severity`

Delete a severity

List Status Page Components`incident_list_status_page_components`

List all status page components for an organisation.

Get Status Page Component`incident_get_status_page_component`

Show a single status page component.

Create Status Page Component`incident_create_status_page_component`

Create a status page component.

Update Status Page Component`incident_update_status_page_component`

Update a status page component's name and description.

Delete Status Page Component`incident_delete_status_page_component`

Archive a status page component.

List Status Page Incidents`incident_list_status_page_incidents`

List status page incidents.

List Status Page Maintenances`incident_list_status_page_maintenances`

List status page maintenances.

List Status Page Response Incidents`incident_list_status_page_response_incidents`

List the linked Response incidents for a status page incident.

List Status Pages`incident_list_status_pages`

List all status pages for your organisation.

Get Status Page Component Availability`incident_get_status_page_component_availability`

Show availability for a status page component over a time window.

Get Status Page`incident_get_status_page`

Show a single status page.

Get Status Page Incident`incident_get_status_page_incident`

Show a status page incident.

Get Status Page Maintenance`incident_get_status_page_maintenance`

Show a status page maintenance window.

Get Status Page Structure`incident_get_status_page_structure`

Show the structure of a status page.

Create Status Page Incident`incident_create_status_page_incident`

Create a status page incident.

Create Status Page Incident Update`incident_create_status_page_incident_update`

Post an update on a Status Page incident.

Create Status Page Maintenance`incident_create_status_page_maintenance`

Schedule a Status Page maintenance window.

Create Status Page Maintenance Update`incident_create_status_page_maintenance_update`

Post an update on a Status Page maintenance window.

Create Status Page Retrospective Incident`incident_create_status_page_retrospective_incident`

Create a retrospective (historical) status page incident.

Update Status Page Incident`incident_update_status_page_incident`

Update a status page incident.

Update Status Page Maintenance`incident_update_status_page_maintenance`

Update the name and scheduled window of a Status Page maintenance window.

Delete Status Page Maintenance`incident_delete_status_page_maintenance`

Delete a Status Page maintenance window.

List Teams`incident_list_teams`

List all teams in the organisation.

Get Team`incident_get_team`

Get a single team.

List Notification Methods`incident_list_notification_methods`

List notification methods for a user.

List Notification Rules`incident_list_notification_rules`

List notification rules for a user.

List Users`incident_list_users`

List users in your account.

Get Paging Provider`incident_get_paging_provider`

Show the paging provider that would be used to escalate to this user.

Get User`incident_get_user`

Get a single user.

Update Paging Provider`incident_update_paging_provider`

Update a user's preferred paging provider.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.