Supercharge your incident management with incident.io – the leading platform for orchestrating incidents, streamlining response processes, and tracking action items all in one place. Seamlessly integrate incident.io into your automated workflows to take command of incident creation, real-time collaboration, follow-ups, scheduling, escalations, and much more.
With the incident.io tool, you can:
- List and search incidents: Quickly retrieve a list of ongoing or historical incidents, complete with metadata such as severity, status, and timestamps, using
incidentio_incidents_list.
- Create new incidents: Trigger new incident creation programmatically via
incidentio_incidents_create, specifying severity, name, type, and custom details to ensure nothing slows your response down.
- Automate incident follow-ups: Leverage incident.io’s powerful automation to ensure important action items and learnings aren't missed, helping teams resolve issues and improve processes.
- Customize workflows: Integrate bespoke incident types, severities, and custom fields tailored to your organization’s needs.
- Enforce best practices with schedules & escalations: Streamline on-call and incident management by automatically assigning, notifying, and escalating as situations evolve.
incident.io empowers modern organizations to respond faster, coordinate teams, and capture learnings for continuous improvement. Whether you manage SRE, DevOps, Security, or IT incidents, incident.io brings centralized, best-in-class incident response programmatically to your agent workflows.
Key operations available:
incidentio_incidents_list: List, paginate and filter incidents with full detail.
incidentio_incidents_create: Programmatically open new incidents with custom attributes and control over duplication (idempotency).
- ...and more to come!
Enhance your reliability, accountability, and operational excellence by integrating incident.io with your workflow automations today.
Integrate incident.io into the workflow. Manage incidents, actions, follow-ups, workflows, schedules, escalations, custom fields, and more.
List incidents from incident.io. Returns a list of incidents with their details including severity, status, and timestamps.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
page_size | number | No | Number of incidents to return per page (default: 25) |
after | string | No | Pagination cursor to fetch the next page of results |
| Parameter | Type | Description |
|---|
incidents | array | List of incidents |
↳ id | string | Type ID |
↳ name | string | Type name |
↳ summary | string | Brief summary of the incident |
↳ description | string | Detailed description of the incident |
↳ mode | string | Incident mode (e.g., standard, retrospective) |
↳ call_url | string | URL for the incident call/bridge |
↳ severity | object | Severity of the incident |
↳ id | string | Severity ID |
↳ name | string | Severity name |
↳ rank | number | Severity rank |
↳ rank | number | Severity rank |
↳ status | object | Current status of the incident |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ category | string | Status category |
↳ category | string | Status category |
↳ incident_type | object | Type of the incident |
↳ id | string | Type ID |
↳ name | string | Type name |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ incident_url | string | URL to the incident |
↳ slack_channel_id | string | Associated Slack channel ID |
↳ slack_channel_name | string | Associated Slack channel name |
↳ visibility | string | Incident visibility |
pagination_meta | object | Pagination metadata |
↳ after | string | Cursor for the next page |
↳ page_size | number | Number of items per page |
↳ total_record_count | number | Total number of records available |
Create a new incident in incident.io. Requires idempotency_key, severity_id, and visibility. Optionally accepts name, summary, type, and status.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
idempotency_key | string | Yes | Unique identifier to prevent duplicate incident creation. Use a UUID or unique string. |
name | string | No | Name of the incident (optional) |
summary | string | No | Brief summary of the incident |
severity_id | string | Yes | ID of the severity level (required) |
incident_type_id | string | No | ID of the incident type |
incident_status_id | string | No | ID of the initial incident status |
visibility | string | Yes | Visibility of the incident: "public" or "private" (required) |
| Parameter | Type | Description |
|---|
incident | object | The created incident object |
↳ id | string | Type ID |
↳ name | string | Type name |
↳ summary | string | Brief summary of the incident |
↳ description | string | Detailed description of the incident |
↳ mode | string | Incident mode (e.g., standard, retrospective) |
↳ call_url | string | URL for the incident call/bridge |
↳ severity | object | Severity of the incident |
↳ id | string | Severity ID |
↳ name | string | Severity name |
↳ rank | number | Severity rank |
↳ rank | number | Severity rank |
↳ status | object | Current status of the incident |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ category | string | Status category |
↳ category | string | Status category |
↳ incident_type | object | Type of the incident |
↳ id | string | Type ID |
↳ name | string | Type name |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ incident_url | string | URL to the incident |
↳ slack_channel_id | string | Associated Slack channel ID |
↳ slack_channel_name | string | Associated Slack channel name |
↳ visibility | string | Incident visibility |
Retrieve detailed information about a specific incident from incident.io by its ID. Returns full incident details including custom fields and role assignments.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | ID of the incident to retrieve |
| Parameter | Type | Description |
|---|
incident | object | Detailed incident information |
↳ id | string | Type ID |
↳ name | string | Type name |
↳ summary | string | Brief summary of the incident |
↳ description | string | Detailed description of the incident |
↳ mode | string | Incident mode (e.g., standard, retrospective) |
↳ call_url | string | URL for the incident call/bridge |
↳ permalink | string | Permanent link to the incident |
↳ severity | object | Severity of the incident |
↳ id | string | Severity ID |
↳ name | string | Severity name |
↳ rank | number | Severity rank |
↳ rank | number | Severity rank |
↳ status | object | Current status of the incident |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ category | string | Status category |
↳ category | string | Status category |
↳ incident_type | object | Type of the incident |
↳ id | string | Type ID |
↳ name | string | Type name |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ incident_url | string | URL to the incident |
↳ slack_channel_id | string | Associated Slack channel ID |
↳ slack_channel_name | string | Associated Slack channel name |
↳ visibility | string | Incident visibility |
↳ custom_field_entries | array | Custom field values for the incident |
↳ incident_role_assignments | array | Role assignments for the incident |
Update an existing incident in incident.io. Can update name, summary, severity, status, or type.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | ID of the incident to update |
name | string | No | Updated name of the incident |
summary | string | No | Updated summary of the incident |
severity_id | string | No | Updated severity ID for the incident |
incident_status_id | string | No | Updated status ID for the incident |
incident_type_id | string | No | Updated incident type ID |
notify_incident_channel | boolean | Yes | Whether to notify the incident channel about this update |
| Parameter | Type | Description |
|---|
incident | object | The updated incident object |
↳ id | string | Type ID |
↳ name | string | Type name |
↳ summary | string | Brief summary of the incident |
↳ description | string | Detailed description of the incident |
↳ mode | string | Incident mode (e.g., standard, retrospective) |
↳ call_url | string | URL for the incident call/bridge |
↳ severity | object | Severity of the incident |
↳ id | string | Severity ID |
↳ name | string | Severity name |
↳ rank | number | Severity rank |
↳ rank | number | Severity rank |
↳ status | object | Current status of the incident |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ category | string | Status category |
↳ category | string | Status category |
↳ incident_type | object | Type of the incident |
↳ id | string | Type ID |
↳ name | string | Type name |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ incident_url | string | URL to the incident |
↳ slack_channel_id | string | Associated Slack channel ID |
↳ slack_channel_name | string | Associated Slack channel name |
↳ visibility | string | Incident visibility |
List actions from incident.io. Optionally filter by incident ID.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
incident_id | string | No | Filter actions by incident ID |
page_size | number | No | Number of actions to return per page |
| Parameter | Type | Description |
|---|
actions | array | List of actions |
↳ id | string | User ID |
↳ description | string | Action description |
↳ assignee | object | Assigned user |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ name | string | User name |
↳ email | string | User email |
↳ status | string | Action status |
↳ due_at | string | Due date/time |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ incident_id | string | Associated incident ID |
↳ creator | object | User who created the action |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ completed_at | string | Completion timestamp |
↳ external_issue_reference | object | External issue tracking reference |
↳ provider | string | Issue tracking provider (e.g., Jira, Linear) |
↳ issue_name | string | Issue identifier |
↳ issue_permalink | string | URL to the external issue |
↳ provider | string | Issue tracking provider (e.g., Jira, Linear) |
↳ issue_name | string | Issue identifier |
↳ issue_permalink | string | URL to the external issue |
Get detailed information about a specific action from incident.io.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | Action ID |
| Parameter | Type | Description |
|---|
action | object | Action details |
↳ id | string | User ID |
↳ description | string | Action description |
↳ assignee | object | Assigned user |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ name | string | User name |
↳ email | string | User email |
↳ status | string | Action status |
↳ due_at | string | Due date/time |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ incident_id | string | Associated incident ID |
↳ creator | object | User who created the action |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ completed_at | string | Completion timestamp |
↳ external_issue_reference | object | External issue tracking reference |
↳ provider | string | Issue tracking provider (e.g., Jira, Linear) |
↳ issue_name | string | Issue identifier |
↳ issue_permalink | string | URL to the external issue |
↳ provider | string | Issue tracking provider (e.g., Jira, Linear) |
↳ issue_name | string | Issue identifier |
↳ issue_permalink | string | URL to the external issue |
List follow-ups from incident.io. Optionally filter by incident ID.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
incident_id | string | No | Filter follow-ups by incident ID |
page_size | number | No | Number of follow-ups to return per page |
| Parameter | Type | Description |
|---|
follow_ups | array | List of follow-ups |
↳ id | string | User ID |
↳ title | string | Follow-up title |
↳ description | string | Priority description |
↳ assignee | object | Assigned user |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ name | string | User name |
↳ email | string | User email |
↳ status | string | Follow-up status |
↳ priority | object | Follow-up priority |
↳ id | string | Priority ID |
↳ name | string | Priority name |
↳ description | string | Priority description |
↳ rank | number | Priority rank |
↳ rank | number | Priority rank |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ incident_id | string | Associated incident ID |
↳ creator | object | User who created the follow-up |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ completed_at | string | Completion timestamp |
↳ labels | array | Labels associated with the follow-up |
↳ external_issue_reference | object | External issue tracking reference |
↳ provider | string | External provider name |
↳ issue_name | string | External issue name or ID |
↳ issue_permalink | string | Permalink to external issue |
↳ provider | string | External provider name |
↳ issue_name | string | External issue name or ID |
↳ issue_permalink | string | Permalink to external issue |
Get detailed information about a specific follow-up from incident.io.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | Follow-up ID |
| Parameter | Type | Description |
|---|
follow_up | object | Follow-up details |
↳ id | string | User ID |
↳ title | string | Follow-up title |
↳ description | string | Priority description |
↳ assignee | object | Assigned user |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ name | string | User name |
↳ email | string | User email |
↳ status | string | Follow-up status |
↳ priority | object | Follow-up priority |
↳ id | string | Priority ID |
↳ name | string | Priority name |
↳ description | string | Priority description |
↳ rank | number | Priority rank |
↳ rank | number | Priority rank |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ incident_id | string | Associated incident ID |
↳ creator | object | User who created the follow-up |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ completed_at | string | Completion timestamp |
↳ labels | array | Labels associated with the follow-up |
↳ external_issue_reference | object | External issue tracking reference |
↳ provider | string | External provider name |
↳ issue_name | string | External issue name or ID |
↳ issue_permalink | string | Permalink to external issue |
↳ provider | string | External provider name |
↳ issue_name | string | External issue name or ID |
↳ issue_permalink | string | Permalink to external issue |
List all users in your Incident.io workspace. Returns user details including id, name, email, and role.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Incident.io API Key |
page_size | number | No | Number of results to return per page (default: 25) |
| Parameter | Type | Description |
|---|
users | array | List of users in the workspace |
↳ id | string | Unique identifier for the user |
↳ name | string | Full name of the user |
↳ email | string | Email address of the user |
↳ role | string | Role of the user in the workspace |
Get detailed information about a specific user in your Incident.io workspace by their ID.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Incident.io API Key |
id | string | Yes | The unique identifier of the user to retrieve |
| Parameter | Type | Description |
|---|
user | object | Details of the requested user |
↳ id | string | Unique identifier for the user |
↳ name | string | Full name of the user |
↳ email | string | Email address of the user |
↳ role | string | Role of the user in the workspace |
List all workflows in your incident.io workspace.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
page_size | number | No | Number of workflows to return per page |
after | string | No | Pagination cursor to fetch the next page of results |
| Parameter | Type | Description |
|---|
workflows | array | List of workflows |
↳ id | string | Unique identifier for the workflow |
↳ name | string | Name of the workflow |
↳ state | string | State of the workflow (active, draft, or disabled) |
↳ folder | string | Folder the workflow belongs to |
↳ created_at | string | When the workflow was created |
↳ updated_at | string | When the workflow was last updated |
pagination_meta | object | Pagination metadata |
↳ after | string | Cursor for next page |
↳ page_size | number | Number of results per page |
Get details of a specific workflow in incident.io.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the workflow to retrieve |
| Parameter | Type | Description |
|---|
workflow | object | The workflow details |
↳ id | string | Unique identifier for the workflow |
↳ name | string | Name of the workflow |
↳ state | string | State of the workflow (active, draft, or disabled) |
↳ folder | string | Folder the workflow belongs to |
↳ created_at | string | When the workflow was created |
↳ updated_at | string | When the workflow was last updated |
Update an existing workflow in incident.io.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the workflow to update |
name | string | No | New name for the workflow |
state | string | No | New state for the workflow (active, draft, or disabled) |
folder | string | No | New folder for the workflow |
| Parameter | Type | Description |
|---|
workflow | object | The updated workflow |
↳ id | string | Unique identifier for the workflow |
↳ name | string | Name of the workflow |
↳ state | string | State of the workflow (active, draft, or disabled) |
↳ folder | string | Folder the workflow belongs to |
↳ created_at | string | When the workflow was created |
↳ updated_at | string | When the workflow was last updated |
Delete a workflow in incident.io.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the workflow to delete |
| Parameter | Type | Description |
|---|
message | string | Success message |
List all schedules in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
page_size | number | No | Number of results per page (default: 25) |
after | string | No | Pagination cursor to fetch the next page of results |
| Parameter | Type | Description |
|---|
schedules | array | List of schedules |
↳ id | string | The schedule ID |
↳ name | string | The schedule name |
↳ timezone | string | The schedule timezone |
↳ created_at | string | When the schedule was created |
↳ updated_at | string | When the schedule was last updated |
pagination_meta | object | Pagination metadata |
↳ after | string | Cursor for next page |
↳ page_size | number | Number of results per page |
Create a new schedule in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
name | string | Yes | Name of the schedule |
timezone | string | Yes | Timezone for the schedule (e.g., America/New_York) |
config | string | Yes | Schedule configuration as JSON string with rotations. Example: {"rotations": [{"name": "Primary", "users": [{"id": "user_id"}], "handover_start_at": "2024-01-01T09:00:00Z", "handovers": [{"interval": 1, "interval_type": "weekly"}]}]} |
Example | string | No | No description |
| Parameter | Type | Description |
|---|
schedule | object | The created schedule |
↳ id | string | The schedule ID |
↳ name | string | The schedule name |
↳ timezone | string | The schedule timezone |
↳ created_at | string | When the schedule was created |
↳ updated_at | string | When the schedule was last updated |
Get details of a specific schedule in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the schedule |
| Parameter | Type | Description |
|---|
schedule | object | The schedule details |
↳ id | string | The schedule ID |
↳ name | string | The schedule name |
↳ timezone | string | The schedule timezone |
↳ created_at | string | When the schedule was created |
↳ updated_at | string | When the schedule was last updated |
Update an existing schedule in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the schedule to update |
name | string | No | New name for the schedule |
timezone | string | No | New timezone for the schedule (e.g., America/New_York) |
config | string | No | Schedule configuration as JSON string with rotations. Example: {"rotations": [{"name": "Primary", "users": [{"id": "user_id"}], "handover_start_at": "2024-01-01T09:00:00Z", "handovers": [{"interval": 1, "interval_type": "weekly"}]}]} |
Example | string | No | No description |
| Parameter | Type | Description |
|---|
schedule | object | The updated schedule |
↳ id | string | The schedule ID |
↳ name | string | The schedule name |
↳ timezone | string | The schedule timezone |
↳ created_at | string | When the schedule was created |
↳ updated_at | string | When the schedule was last updated |
Delete a schedule in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the schedule to delete |
| Parameter | Type | Description |
|---|
message | string | Success message |
List all escalation policies in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
page_size | number | No | Number of results per page (default: 25) |
| Parameter | Type | Description |
|---|
escalations | array | List of escalation policies |
↳ id | string | The escalation policy ID |
↳ name | string | The escalation policy name |
↳ created_at | string | When the escalation policy was created |
↳ updated_at | string | When the escalation policy was last updated |
Create a new escalation policy in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
idempotency_key | string | Yes | Unique identifier to prevent duplicate escalation creation. Use a UUID or unique string. |
title | string | Yes | Title of the escalation |
escalation_path_id | string | No | ID of the escalation path to use (required if user_ids not provided) |
user_ids | string | No | Comma-separated list of user IDs to notify (required if escalation_path_id not provided) |
| Parameter | Type | Description |
|---|
escalation | object | The created escalation policy |
↳ id | string | The escalation policy ID |
↳ name | string | The escalation policy name |
↳ created_at | string | When the escalation policy was created |
↳ updated_at | string | When the escalation policy was last updated |
Get details of a specific escalation policy in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the escalation policy |
| Parameter | Type | Description |
|---|
escalation | object | The escalation policy details |
↳ id | string | The escalation policy ID |
↳ name | string | The escalation policy name |
↳ created_at | string | When the escalation policy was created |
↳ updated_at | string | When the escalation policy was last updated |
List all custom fields from incident.io.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
| Parameter | Type | Description |
|---|
custom_fields | array | List of custom fields |
↳ id | string | Custom field ID |
↳ name | string | Custom field name |
↳ description | string | Custom field description |
↳ field_type | string | Custom field type |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
Create a new custom field in incident.io.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
name | string | Yes | Name of the custom field |
description | string | Yes | Description of the custom field (required) |
field_type | string | Yes | Type of the custom field (e.g., text, single_select, multi_select, numeric, datetime, link, user, team) |
| Parameter | Type | Description |
|---|
custom_field | object | Created custom field |
↳ id | string | Custom field ID |
↳ name | string | Custom field name |
↳ description | string | Custom field description |
↳ field_type | string | Custom field type |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
Get detailed information about a specific custom field from incident.io.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | Custom field ID |
| Parameter | Type | Description |
|---|
custom_field | object | Custom field details |
↳ id | string | Custom field ID |
↳ name | string | Custom field name |
↳ description | string | Custom field description |
↳ field_type | string | Custom field type |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
Update an existing custom field in incident.io.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | Custom field ID |
name | string | Yes | New name for the custom field (required) |
description | string | Yes | New description for the custom field (required) |
| Parameter | Type | Description |
|---|
custom_field | object | Updated custom field |
↳ id | string | Custom field ID |
↳ name | string | Custom field name |
↳ description | string | Custom field description |
↳ field_type | string | Custom field type |
↳ created_at | string | Creation timestamp |
↳ updated_at | string | Last update timestamp |
Delete a custom field from incident.io.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | Custom field ID |
| Parameter | Type | Description |
|---|
message | string | Success message |
List all severity levels configured in your Incident.io workspace. Returns severity details including id, name, description, and rank.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Incident.io API Key |
| Parameter | Type | Description |
|---|
severities | array | List of severity levels |
↳ id | string | Unique identifier for the severity level |
↳ name | string | Name of the severity level |
↳ description | string | Description of the severity level |
↳ rank | number | Rank/order of the severity level |
List all incident statuses configured in your Incident.io workspace. Returns status details including id, name, description, and category.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Incident.io API Key |
| Parameter | Type | Description |
|---|
incident_statuses | array | List of incident statuses |
↳ id | string | Unique identifier for the incident status |
↳ name | string | Name of the incident status |
↳ description | string | Description of the incident status |
↳ category | string | Category of the incident status |
List all incident types configured in your Incident.io workspace. Returns type details including id, name, description, and default flag.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Incident.io API Key |
| Parameter | Type | Description |
|---|
incident_types | array | List of incident types |
↳ id | string | Unique identifier for the incident type |
↳ name | string | Name of the incident type |
↳ description | string | Description of the incident type |
↳ is_default | boolean | Whether this is the default incident type |
List all incident roles in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
| Parameter | Type | Description |
|---|
incident_roles | array | List of incident roles |
↳ id | string | The incident role ID |
↳ name | string | The incident role name |
↳ description | string | The incident role description |
↳ instructions | string | Instructions for the role |
↳ shortform | string | Short form abbreviation of the role |
↳ role_type | string | The type of role |
↳ required | boolean | Whether the role is required |
↳ created_at | string | When the role was created |
↳ updated_at | string | When the role was last updated |
Create a new incident role in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
name | string | Yes | Name of the incident role |
description | string | Yes | Description of the incident role |
instructions | string | Yes | Instructions for the incident role |
shortform | string | Yes | Short form abbreviation for the role |
| Parameter | Type | Description |
|---|
incident_role | object | The created incident role |
↳ id | string | The incident role ID |
↳ name | string | The incident role name |
↳ description | string | The incident role description |
↳ instructions | string | Instructions for the role |
↳ shortform | string | Short form abbreviation of the role |
↳ role_type | string | The type of role |
↳ required | boolean | Whether the role is required |
↳ created_at | string | When the role was created |
↳ updated_at | string | When the role was last updated |
Get details of a specific incident role in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the incident role |
| Parameter | Type | Description |
|---|
incident_role | object | The incident role details |
↳ id | string | The incident role ID |
↳ name | string | The incident role name |
↳ description | string | The incident role description |
↳ instructions | string | Instructions for the role |
↳ shortform | string | Short form abbreviation of the role |
↳ role_type | string | The type of role |
↳ required | boolean | Whether the role is required |
↳ created_at | string | When the role was created |
↳ updated_at | string | When the role was last updated |
Update an existing incident role in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the incident role to update |
name | string | Yes | Name of the incident role |
description | string | Yes | Description of the incident role |
instructions | string | Yes | Instructions for the incident role |
shortform | string | Yes | Short form abbreviation for the role |
| Parameter | Type | Description |
|---|
incident_role | object | The updated incident role |
↳ id | string | The incident role ID |
↳ name | string | The incident role name |
↳ description | string | The incident role description |
↳ instructions | string | Instructions for the role |
↳ shortform | string | Short form abbreviation of the role |
↳ role_type | string | The type of role |
↳ required | boolean | Whether the role is required |
↳ created_at | string | When the role was created |
↳ updated_at | string | When the role was last updated |
Delete an incident role in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the incident role to delete |
| Parameter | Type | Description |
|---|
message | string | Success message |
List all incident timestamp definitions in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
| Parameter | Type | Description |
|---|
incident_timestamps | array | List of incident timestamp definitions |
↳ id | string | The timestamp ID |
↳ name | string | The timestamp name |
↳ rank | number | The rank/order of the timestamp |
↳ created_at | string | When the timestamp was created |
↳ updated_at | string | When the timestamp was last updated |
Get details of a specific incident timestamp definition in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the incident timestamp |
| Parameter | Type | Description |
|---|
incident_timestamp | object | The incident timestamp details |
↳ id | string | The timestamp ID |
↳ name | string | The timestamp name |
↳ rank | number | The rank/order of the timestamp |
↳ created_at | string | When the timestamp was created |
↳ updated_at | string | When the timestamp was last updated |
List all updates for a specific incident in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
incident_id | string | No | The ID of the incident to get updates for (optional - if not provided, returns all updates) |
page_size | number | No | Number of results to return per page |
after | string | No | Cursor for pagination |
| Parameter | Type | Description |
|---|
incident_updates | array | List of incident updates |
↳ id | string | User ID |
↳ incident_id | string | The incident ID |
↳ message | string | The update message |
↳ new_severity | object | New severity if changed |
↳ id | string | Severity ID |
↳ name | string | Severity name |
↳ rank | number | Severity rank |
↳ name | string | User name |
↳ rank | number | Severity rank |
↳ new_status | object | New status if changed |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ category | string | Status category |
↳ category | string | Status category |
↳ updater | object | User who created the update |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ email | string | User email |
↳ created_at | string | When the update was created |
↳ updated_at | string | When the update was last modified |
pagination_meta | object | Pagination information |
↳ after | string | Cursor for next page |
↳ page_size | number | Number of results per page |
List all entries for a specific schedule in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
schedule_id | string | Yes | The ID of the schedule to get entries for |
entry_window_start | string | No | Start date/time to filter entries (ISO 8601 format) |
entry_window_end | string | No | End date/time to filter entries (ISO 8601 format) |
page_size | number | No | Number of results to return per page |
after | string | No | Cursor for pagination |
| Parameter | Type | Description |
|---|
schedule_entries | array | List of schedule entries |
↳ id | string | User ID |
↳ schedule_id | string | The schedule ID |
↳ user | object | User assigned to this entry |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ name | string | User name |
↳ email | string | User email |
↳ start_at | string | When the entry starts |
↳ end_at | string | When the entry ends |
↳ layer_id | string | The schedule layer ID |
↳ created_at | string | When the entry was created |
↳ updated_at | string | When the entry was last updated |
pagination_meta | object | Pagination information |
↳ after | string | Cursor for next page |
↳ after_url | string | URL for next page |
↳ page_size | number | Number of results per page |
Create a new schedule override in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
rotation_id | string | Yes | The ID of the rotation to override |
schedule_id | string | Yes | The ID of the schedule |
user_id | string | No | The ID of the user to assign (provide one of: user_id, user_email, or user_slack_id) |
user_email | string | No | The email of the user to assign (provide one of: user_id, user_email, or user_slack_id) |
user_slack_id | string | No | The Slack ID of the user to assign (provide one of: user_id, user_email, or user_slack_id) |
start_at | string | Yes | When the override starts (ISO 8601 format) |
end_at | string | Yes | When the override ends (ISO 8601 format) |
| Parameter | Type | Description |
|---|
override | object | The created schedule override |
↳ id | string | User ID |
↳ rotation_id | string | The rotation ID |
↳ schedule_id | string | The schedule ID |
↳ user | object | User assigned to this override |
↳ id | string | User ID |
↳ name | string | User name |
↳ email | string | User email |
↳ name | string | User name |
↳ email | string | User email |
↳ start_at | string | When the override starts |
↳ end_at | string | When the override ends |
↳ created_at | string | When the override was created |
↳ updated_at | string | When the override was last updated |
Create a new escalation path in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
name | string | Yes | Name of the escalation path |
path | json | Yes | Array of escalation levels with targets and time to acknowledge in seconds. Each level should have: targets (array of {id, type, schedule_id?, user_id?, urgency}) and time_to_ack_seconds (number) |
working_hours | json | No | Optional working hours configuration. Array of {weekday, start_time, end_time} |
| Parameter | Type | Description |
|---|
escalation_path | object | The created escalation path |
↳ id | string | Target ID |
↳ name | string | The escalation path name |
↳ path | array | Array of escalation levels |
↳ targets | array | Targets for this level |
↳ id | string | Target ID |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ id | string | Target ID |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ time_to_ack_seconds | number | Time to acknowledge in seconds |
↳ targets | array | Targets for this level |
↳ id | string | Target ID |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ time_to_ack_seconds | number | Time to acknowledge in seconds |
↳ working_hours | array | Working hours configuration |
↳ weekday | string | Day of week |
↳ start_time | string | Start time |
↳ end_time | string | End time |
↳ weekday | string | Day of week |
↳ start_time | string | Start time |
↳ end_time | string | End time |
↳ created_at | string | When the path was created |
↳ updated_at | string | When the path was last updated |
Get details of a specific escalation path in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the escalation path |
| Parameter | Type | Description |
|---|
escalation_path | object | The escalation path details |
↳ id | string | Target ID |
↳ name | string | The escalation path name |
↳ path | array | Array of escalation levels |
↳ targets | array | Targets for this level |
↳ id | string | Target ID |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ id | string | Target ID |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ time_to_ack_seconds | number | Time to acknowledge in seconds |
↳ targets | array | Targets for this level |
↳ id | string | Target ID |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ time_to_ack_seconds | number | Time to acknowledge in seconds |
↳ working_hours | array | Working hours configuration |
↳ weekday | string | Day of week |
↳ start_time | string | Start time |
↳ end_time | string | End time |
↳ weekday | string | Day of week |
↳ start_time | string | Start time |
↳ end_time | string | End time |
↳ created_at | string | When the path was created |
↳ updated_at | string | When the path was last updated |
Update an existing escalation path in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the escalation path to update |
name | string | No | New name for the escalation path |
path | json | No | New escalation path configuration. Array of escalation levels with targets and time_to_ack_seconds |
working_hours | json | No | New working hours configuration. Array of {weekday, start_time, end_time} |
| Parameter | Type | Description |
|---|
escalation_path | object | The updated escalation path |
↳ id | string | Target ID |
↳ name | string | The escalation path name |
↳ path | array | Array of escalation levels |
↳ targets | array | Targets for this level |
↳ id | string | Target ID |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ id | string | Target ID |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ time_to_ack_seconds | number | Time to acknowledge in seconds |
↳ targets | array | Targets for this level |
↳ id | string | Target ID |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ type | string | Target type |
↳ schedule_id | string | Schedule ID if type is schedule |
↳ user_id | string | User ID if type is user |
↳ urgency | string | Urgency level |
↳ time_to_ack_seconds | number | Time to acknowledge in seconds |
↳ working_hours | array | Working hours configuration |
↳ weekday | string | Day of week |
↳ start_time | string | Start time |
↳ end_time | string | End time |
↳ weekday | string | Day of week |
↳ start_time | string | Start time |
↳ end_time | string | End time |
↳ created_at | string | When the path was created |
↳ updated_at | string | When the path was last updated |
Delete an escalation path in incident.io
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | incident.io API Key |
id | string | Yes | The ID of the escalation path to delete |
| Parameter | Type | Description |
|---|
message | string | Success message |