incidentio
Manage incidents with incident.io
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 | No description |
page_size | number | No | No description |
after | string | No | Pagination cursor to fetch the next page of results (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
incidents | array | List of incidents |
↳ id | string | Incident ID |
↳ name | string | Incident name/title |
↳ summary | string | Incident summary |
↳ description | string | Incident description |
↳ mode | string | Incident mode (standard, retrospective, test) |
↳ call_url | string | Video call URL |
↳ severity | object | Incident severity |
↳ id | string | Severity ID |
↳ name | string | Severity name (e.g., Critical, Major, Minor) |
↳ description | string | Severity description |
↳ rank | number | Severity rank (lower = more severe) |
↳ status | object | Current incident status |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ description | string | Status description |
↳ category | string | Status category (triage, active, post-incident, closed) |
↳ incident_type | object | Incident type |
↳ id | string | Incident type ID |
↳ name | string | Incident type name |
↳ description | string | Incident type description |
↳ is_default | boolean | Whether this is the default incident type |
↳ created_at | string | When the incident was created (ISO 8601) |
↳ updated_at | string | When the incident was last updated (ISO 8601) |
↳ incident_url | string | URL to the incident page |
↳ slack_channel_id | string | Slack channel ID |
↳ slack_channel_name | string | Slack channel name |
↳ visibility | string | Incident visibility (public, private) |
pagination_meta | object | Pagination metadata |
↳ after | string | Cursor for next page |
↳ page_size | number | Number of items per page |
↳ total_record_count | number | Total number of records |
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 | No description |
idempotency_key | string | Yes | Unique identifier to prevent duplicate incident creation. Use a UUID or unique string. |
name | string | No | Name of the incident (e.g., "Database connection issues") |
summary | string | No | Brief summary of the incident (e.g., "Intermittent connection failures to primary database") |
severity_id | string | Yes | ID of the severity level (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
incident_type_id | string | No | No description |
incident_status_id | string | No | No description |
visibility | string | Yes | Visibility of the incident: "public" or "private" (required) |
| Parameter | Type | Description |
|---|
incident | object | The created incident object |
↳ id | string | Incident ID |
↳ name | string | Incident 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 |
↳ status | object | Current status of the incident |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ 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 | No description |
id | string | Yes | ID of the incident to retrieve (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
incident | object | Detailed incident information |
↳ id | string | Incident ID |
↳ name | string | Incident 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 |
↳ status | object | Current status of the incident |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ 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 | No description |
id | string | Yes | ID of the incident to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
name | string | No | Updated name of the incident (e.g., "Database connection issues") |
summary | string | No | Updated summary of the incident (e.g., "Intermittent connection failures to primary database") |
severity_id | string | No | Updated severity ID for the incident (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
incident_status_id | string | No | Updated status ID for the incident (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
incident_type_id | string | No | No description |
notify_incident_channel | boolean | Yes | No description |
| Parameter | Type | Description |
|---|
incident | object | The updated incident object |
↳ id | string | Incident ID |
↳ name | string | Incident 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 |
↳ status | object | Current status of the incident |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
incident_id | string | No | Filter actions by incident ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
actions | array | List of actions |
↳ id | string | Action ID |
↳ description | string | Action description |
↳ assignee | object | Assigned user |
↳ id | string | User ID |
↳ 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | Action ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
action | object | Action details |
↳ id | string | Action ID |
↳ description | string | Action description |
↳ assignee | object | Assigned user |
↳ id | string | User ID |
↳ 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
incident_id | string | No | Filter follow-ups by incident ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
follow_ups | array | List of follow-ups |
↳ id | string | Follow-up ID |
↳ title | string | Follow-up title |
↳ description | string | Follow-up description |
↳ assignee | object | Assigned user |
↳ id | string | User ID |
↳ 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 |
↳ 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | Follow-up ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
follow_up | object | Follow-up details |
↳ id | string | Follow-up ID |
↳ title | string | Follow-up title |
↳ description | string | Follow-up description |
↳ assignee | object | Assigned user |
↳ id | string | User ID |
↳ 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 |
↳ 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 |
List all users in your Incident.io workspace. Returns user details including id, name, email, and role.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
page_size | number | No | No description |
after | string | No | No description |
| 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 |
pagination_meta | object | Pagination metadata |
↳ after | string | Cursor for next page |
↳ page_size | number | Number of items per page |
↳ total_record_count | number | Total number of records |
Get detailed information about a specific user in your Incident.io workspace by their ID.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The unique identifier of the user to retrieve (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
page_size | number | No | No description |
after | string | No | Pagination cursor to fetch the next page of results (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the workflow to retrieve (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the workflow to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
name | string | No | New name for the workflow (e.g., "Notify on Critical Incidents") |
state | string | No | No description |
folder | string | No | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the workflow to delete (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
message | string | Success message |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
page_size | number | No | No description |
after | string | No | Pagination cursor to fetch the next page of results (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | Name of the schedule (e.g., "Primary On-Call") |
timezone | string | Yes | No description |
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"}]}]} |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the schedule (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the schedule to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
name | string | No | New name for the schedule (e.g., "Primary On-Call") |
timezone | string | No | No description |
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"}]}]} |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the schedule to delete (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
message | string | Success message |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
idempotency_key | string | Yes | Unique identifier to prevent duplicate escalation creation. Use a UUID or unique string. |
title | string | Yes | Title of the escalation (e.g., "Database Critical Alert") |
escalation_path_id | string | No | No description |
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the escalation policy (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | Name of the custom field (e.g., "Affected Service") |
description | string | Yes | No description |
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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | Custom field ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | Custom field ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
name | string | Yes | New name for the custom field (e.g., "Affected Service") |
description | string | Yes | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | Custom field ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| 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 | No description |
| 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 | No description |
| 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 | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | Name of the incident role (e.g., "Incident Commander") |
description | string | Yes | No description |
instructions | string | Yes | No description |
shortform | string | Yes | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the incident role (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the incident role to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
name | string | Yes | Name of the incident role (e.g., "Incident Commander") |
description | string | Yes | No description |
instructions | string | Yes | No description |
shortform | string | Yes | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the incident role to delete (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
message | string | Success message |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the incident timestamp (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
incident_id | string | No | The ID of the incident to get updates for (e.g., "01FCNDV6P870EA6S7TK1DSYDG0"). If not provided, returns all updates |
page_size | number | No | No description |
after | string | No | Cursor for pagination (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
incident_updates | array | List of incident updates |
↳ id | string | The update 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 |
↳ new_status | object | New status if changed |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ category | string | Status category |
↳ updater | object | User who created the update |
↳ id | string | User ID |
↳ name | string | User name |
↳ 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
schedule_id | string | Yes | The ID of the schedule to get entries for (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
entry_window_start | string | No | Start date/time to filter entries in ISO 8601 format (e.g., "2024-01-15T09:00:00Z") |
entry_window_end | string | No | End date/time to filter entries in ISO 8601 format (e.g., "2024-01-22T09:00:00Z") |
page_size | number | No | No description |
after | string | No | Cursor for pagination (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
schedule_entries | array | List of schedule entries |
↳ id | string | The entry 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 |
↳ 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
rotation_id | string | Yes | The ID of the rotation to override (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
schedule_id | string | Yes | The ID of the schedule (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
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 in ISO 8601 format (e.g., "2024-01-15T09:00:00Z") |
end_at | string | Yes | When the override ends in ISO 8601 format (e.g., "2024-01-22T09:00:00Z") |
| Parameter | Type | Description |
|---|
override | object | The created schedule override |
↳ id | string | The override 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 |
↳ 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 |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | Name of the escalation path (e.g., "Critical Incident 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 | No description |
| Parameter | Type | Description |
|---|
escalation_path | object | The created escalation path |
↳ id | string | The escalation path 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 |
↳ 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 |
↳ created_at | string | When the path was created |
↳ updated_at | string | When the path was last updated |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the escalation path (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
escalation_path | object | The escalation path details |
↳ id | string | The escalation path 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 |
↳ 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 |
↳ created_at | string | When the path was created |
↳ updated_at | string | When the path was last updated |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the escalation path to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
name | string | No | New name for the escalation path (e.g., "Critical Incident Path") |
path | json | No | New escalation path configuration. Array of escalation levels with targets and time_to_ack_seconds |
working_hours | json | No | No description |
| Parameter | Type | Description |
|---|
escalation_path | object | The updated escalation path |
↳ id | string | The escalation path 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 |
↳ 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 |
↳ created_at | string | When the path was created |
↳ updated_at | string | When the path was last updated |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
id | string | Yes | The ID of the escalation path to delete (e.g., "01FCNDV6P870EA6S7TK1DSYDG0") |
| Parameter | Type | Description |
|---|
message | string | Success message |
