incident.io

Use incident.io in Studio to create and manage incidents, actions, follow-ups, workflows, schedules, escalations, and custom fields. The action reference below documents each operation and its inputs and outputs.

Usage Instructions

Integrate incident.io into the workflow. Manage incidents, actions, follow-ups, workflows, schedules, escalations, custom fields, and more.

Actions

incident.io Incidents List

List incidents from incident.io. Returns a list of incidents with their details including severity, status, and timestamps.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
page_sizenumberNoNumber of incidents to return per page (e.g., 10, 25, 50). Default: 25
afterstringNoPagination cursor to fetch the next page of results (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
sort_bystringNoSort order for incidents: created_at_newest_first or created_at_oldest_first
filter_modestringNoHow to combine filters: all or any

Output

ParameterTypeDescription
incidentsarrayList of incidents
↳ idstringIncident ID
↳ namestringIncident name/title
↳ summarystringIncident summary
↳ modestringIncident mode (standard, retrospective, test)
↳ call_urlstringVideo call URL
↳ severityobjectIncident severity
↳ idstringSeverity ID
↳ namestringSeverity name (e.g., Critical, Major, Minor)
↳ descriptionstringSeverity description
↳ ranknumberSeverity rank (lower = more severe)
↳ statusobjectCurrent incident status
↳ idstringStatus ID
↳ namestringStatus name
↳ descriptionstringStatus description
↳ categorystringStatus category (triage, active, post-incident, closed)
↳ incident_typeobjectIncident type
↳ idstringIncident type ID
↳ namestringIncident type name
↳ descriptionstringIncident type description
↳ is_defaultbooleanWhether this is the default incident type
↳ created_atstringWhen the incident was created (ISO 8601)
↳ updated_atstringWhen the incident was last updated (ISO 8601)
↳ permalinkstringPermalink to the incident in incident.io
↳ slack_channel_idstringSlack channel ID
↳ slack_channel_namestringSlack channel name
↳ visibilitystringIncident visibility (public, private)
pagination_metaobjectPagination metadata
↳ afterstringCursor for next page
↳ page_sizenumberNumber of items per page
↳ total_record_countnumberTotal number of records

incident.io Incidents Create

Create a new incident in incident.io. Requires idempotency_key, severity_id, and visibility. Optionally accepts name, summary, type, and status.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idempotency_keystringYesUnique identifier to prevent duplicate incident creation. Use a UUID or unique string.
namestringNoName of the incident (e.g., "Database connection issues")
summarystringNoBrief summary of the incident (e.g., "Intermittent connection failures to primary database")
severity_idstringYesID of the severity level (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
incident_type_idstringNoID of the incident type
incident_status_idstringNoID of the initial incident status
visibilitystringYesVisibility of the incident: "public" or "private" (required)

Output

ParameterTypeDescription
incidentobjectThe created incident object
↳ idstringIncident ID
↳ namestringIncident name
↳ summarystringBrief summary of the incident
↳ modestringIncident mode (e.g., standard, retrospective)
↳ call_urlstringURL for the incident call/bridge
↳ severityobjectSeverity of the incident
↳ idstringSeverity ID
↳ namestringSeverity name
↳ ranknumberSeverity rank
↳ statusobjectCurrent status of the incident
↳ idstringStatus ID
↳ namestringStatus name
↳ categorystringStatus category
↳ incident_typeobjectType of the incident
↳ idstringType ID
↳ namestringType name
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ permalinkstringPermalink to the incident in incident.io
↳ slack_channel_idstringAssociated Slack channel ID
↳ slack_channel_namestringAssociated Slack channel name
↳ visibilitystringIncident visibility

incident.io Incidents Show

Retrieve detailed information about a specific incident from incident.io by its ID. Returns full incident details including custom fields and role assignments.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesID of the incident to retrieve (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
incidentobjectDetailed incident information
↳ idstringIncident ID
↳ namestringIncident name
↳ summarystringBrief summary of the incident
↳ modestringIncident mode (e.g., standard, retrospective)
↳ call_urlstringURL for the incident call/bridge
↳ permalinkstringPermalink to the incident in incident.io
↳ severityobjectSeverity of the incident
↳ idstringSeverity ID
↳ namestringSeverity name
↳ ranknumberSeverity rank
↳ statusobjectCurrent status of the incident
↳ idstringStatus ID
↳ namestringStatus name
↳ categorystringStatus category
↳ incident_typeobjectType of the incident
↳ idstringType ID
↳ namestringType name
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ slack_channel_idstringAssociated Slack channel ID
↳ slack_channel_namestringAssociated Slack channel name
↳ visibilitystringIncident visibility
↳ custom_field_entriesarrayCustom field values for the incident
↳ incident_role_assignmentsarrayRole assignments for the incident

incident.io Incidents Update

Update an existing incident in incident.io. Can update name, summary, severity, status, or type.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesID of the incident to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
namestringNoUpdated name of the incident (e.g., "Database connection issues")
summarystringNoUpdated summary of the incident (e.g., "Intermittent connection failures to primary database")
severity_idstringNoUpdated severity ID for the incident (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
incident_status_idstringNoUpdated status ID for the incident (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
incident_type_idstringNoUpdated incident type ID
notify_incident_channelbooleanYesWhether to notify the incident channel about this update

Output

ParameterTypeDescription
incidentobjectThe updated incident object
↳ idstringIncident ID
↳ namestringIncident name
↳ summarystringBrief summary of the incident
↳ modestringIncident mode (e.g., standard, retrospective)
↳ call_urlstringURL for the incident call/bridge
↳ severityobjectSeverity of the incident
↳ idstringSeverity ID
↳ namestringSeverity name
↳ ranknumberSeverity rank
↳ statusobjectCurrent status of the incident
↳ idstringStatus ID
↳ namestringStatus name
↳ categorystringStatus category
↳ incident_typeobjectType of the incident
↳ idstringType ID
↳ namestringType name
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ permalinkstringPermalink to the incident in incident.io
↳ slack_channel_idstringAssociated Slack channel ID
↳ slack_channel_namestringAssociated Slack channel name
↳ visibilitystringIncident visibility

incident.io Actions List

List actions from incident.io. Optionally filter by incident ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
incident_idstringNoFilter actions by incident ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
incident_modestringNoFilter actions by incident mode (standard, retrospective, test, tutorial, or stream)

Output

ParameterTypeDescription
actionsarrayList of actions
↳ idstringAction ID
↳ descriptionstringAction description
↳ assigneeobjectAssigned user
↳ idstringUser ID
↳ namestringUser name
↳ emailstringUser email
↳ statusstringAction status
↳ due_atstringDue date/time
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ incident_idstringAssociated incident ID
↳ creatorobjectUser who created the action
↳ idstringUser ID
↳ namestringUser name
↳ emailstringUser email
↳ completed_atstringCompletion timestamp
↳ external_issue_referenceobjectExternal issue tracking reference
↳ providerstringIssue tracking provider (e.g., Jira, Linear)
↳ issue_namestringIssue identifier
↳ issue_permalinkstringURL to the external issue

incident.io Actions Show

Get detailed information about a specific action from incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesAction ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
actionobjectAction details
↳ idstringAction ID
↳ descriptionstringAction description
↳ assigneeobjectAssigned user
↳ idstringUser ID
↳ namestringUser name
↳ emailstringUser email
↳ statusstringAction status
↳ due_atstringDue date/time
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ incident_idstringAssociated incident ID
↳ creatorobjectUser who created the action
↳ idstringUser ID
↳ namestringUser name
↳ emailstringUser email
↳ completed_atstringCompletion timestamp
↳ external_issue_referenceobjectExternal issue tracking reference
↳ providerstringIssue tracking provider (e.g., Jira, Linear)
↳ issue_namestringIssue identifier
↳ issue_permalinkstringURL to the external issue

incident.io Follow-ups List

List follow-ups from incident.io. Optionally filter by incident ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
incident_idstringNoFilter follow-ups by incident ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
incident_modestringNoFilter follow-ups by incident mode (standard, retrospective, test, tutorial, or stream)

Output

ParameterTypeDescription
follow_upsarrayList of follow-ups
↳ idstringFollow-up ID
↳ titlestringFollow-up title
↳ descriptionstringFollow-up description
↳ assigneeobjectAssigned user
↳ idstringUser ID
↳ namestringUser name
↳ emailstringUser email
↳ statusstringFollow-up status
↳ priorityobjectFollow-up priority
↳ idstringPriority ID
↳ namestringPriority name
↳ descriptionstringPriority description
↳ ranknumberPriority rank
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ incident_idstringAssociated incident ID
↳ creatorobjectUser who created the follow-up
↳ idstringUser ID
↳ namestringUser name
↳ emailstringUser email
↳ completed_atstringCompletion timestamp
↳ labelsarrayLabels associated with the follow-up
↳ external_issue_referenceobjectExternal issue tracking reference
↳ providerstringExternal provider name
↳ issue_namestringExternal issue name or ID
↳ issue_permalinkstringPermalink to external issue

incident.io Follow-ups Show

Get detailed information about a specific follow-up from incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesFollow-up ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
follow_upobjectFollow-up details
↳ idstringFollow-up ID
↳ titlestringFollow-up title
↳ descriptionstringFollow-up description
↳ assigneeobjectAssigned user
↳ idstringUser ID
↳ namestringUser name
↳ emailstringUser email
↳ statusstringFollow-up status
↳ priorityobjectFollow-up priority
↳ idstringPriority ID
↳ namestringPriority name
↳ descriptionstringPriority description
↳ ranknumberPriority rank
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ incident_idstringAssociated incident ID
↳ creatorobjectUser who created the follow-up
↳ idstringUser ID
↳ namestringUser name
↳ emailstringUser email
↳ completed_atstringCompletion timestamp
↳ labelsarrayLabels associated with the follow-up
↳ external_issue_referenceobjectExternal issue tracking reference
↳ providerstringExternal provider name
↳ issue_namestringExternal issue name or ID
↳ issue_permalinkstringPermalink to external issue

Incident.io Users List

List all users in your Incident.io workspace. Returns user details including id, name, email, and role.

Input

ParameterTypeRequiredDescription
apiKeystringYesIncident.io API Key
page_sizenumberNoNumber of results to return per page (e.g., 10, 25, 50). Default: 25
afterstringNoPagination cursor to fetch the next page of results
emailstringNoFilter users by email address
slack_user_idstringNoFilter users by Slack user ID

Output

ParameterTypeDescription
usersarrayList of users in the workspace
↳ idstringUnique identifier for the user
↳ namestringFull name of the user
↳ emailstringEmail address of the user
↳ rolestringRole of the user in the workspace
pagination_metaobjectPagination metadata
↳ afterstringCursor for next page
↳ page_sizenumberNumber of items per page
↳ total_record_countnumberTotal number of records

Incident.io Users Show

Get detailed information about a specific user in your Incident.io workspace by their ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesIncident.io API Key
idstringYesThe unique identifier of the user to retrieve (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
userobjectDetails of the requested user
↳ idstringUnique identifier for the user
↳ namestringFull name of the user
↳ emailstringEmail address of the user
↳ rolestringRole of the user in the workspace

incident.io Workflows List

List all workflows in your incident.io workspace.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key

Output

ParameterTypeDescription
workflowsarrayList of workflows
↳ idstringWorkflow ID
↳ namestringWorkflow name
↳ triggerstringWorkflow trigger
↳ once_forarrayFields that make the workflow run once
↳ versionnumberWorkflow version
↳ expressionsarrayWorkflow expressions
↳ condition_groupsarrayWorkflow condition groups
↳ stepsarrayWorkflow steps
↳ include_private_incidentsbooleanWhether the workflow includes private incidents
↳ include_private_escalationsbooleanWhether the workflow includes private escalations
↳ runs_on_incident_modesarrayIncident modes the workflow runs on
↳ continue_on_step_errorbooleanWhether execution continues after a step error
↳ runs_on_incidentsstringIncident lifecycle filter
↳ statestringWorkflow state (active, draft, disabled)
↳ delayobjectWorkflow delay configuration
↳ folderstringWorkflow folder
↳ runs_fromstringWhen the workflow runs from
↳ shortformstringWorkflow shortform identifier

incident.io Workflows Create

Create a new workflow in incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
namestringYesName of the workflow (e.g., "Notify on Critical Incidents")
folderstringNoFolder to organize the workflow in
statestringNoState of the workflow (active, draft, or disabled)
triggerstringNoTrigger type for the workflow (e.g., "incident.updated", "incident.created")
stepsstringNoArray of workflow steps as JSON string. Example: [{"label": "Notify team", "name": "slack.post_message"}]
condition_groupsstringNoArray of condition groups as JSON string to control when the workflow runs. Example: [{"conditions": [{"operation": "one_of", "param_bindings": [], "subject": "incident.severity"}]}]
runs_on_incidentsstringNoWhen to run the workflow: "newly_created" (only newly created incidents) or "newly_created_and_active" (newly created and already active incidents)
runs_on_incident_modesstringNoArray of incident modes to run on as JSON string. Example: ["standard", "retrospective"]
include_private_incidentsbooleanNoWhether to include private incidents
continue_on_step_errorbooleanNoWhether to continue executing subsequent steps if a step fails
once_forstringNoArray of fields to ensure the workflow runs only once per unique combination of these fields, as JSON string. Example: ["incident.id"]
expressionsstringNoArray of workflow expressions as JSON string for advanced workflow logic. Example: [{"label": "My expression", "operations": []}]
delaystringNoDelay configuration as JSON string. Example: {"for_seconds": 60, "conditions_apply_over_delay": false}

Output

ParameterTypeDescription
workflowobjectThe created workflow
↳ idstringWorkflow ID
↳ namestringWorkflow name
↳ triggerstringWorkflow trigger
↳ once_forarrayFields that make the workflow run once
↳ versionnumberWorkflow version
↳ expressionsarrayWorkflow expressions
↳ condition_groupsarrayWorkflow condition groups
↳ stepsarrayWorkflow steps
↳ include_private_incidentsbooleanWhether the workflow includes private incidents
↳ include_private_escalationsbooleanWhether the workflow includes private escalations
↳ runs_on_incident_modesarrayIncident modes the workflow runs on
↳ continue_on_step_errorbooleanWhether execution continues after a step error
↳ runs_on_incidentsstringIncident lifecycle filter
↳ statestringWorkflow state (active, draft, disabled)
↳ delayobjectWorkflow delay configuration
↳ folderstringWorkflow folder
↳ runs_fromstringWhen the workflow runs from
↳ shortformstringWorkflow shortform identifier
management_metajsonWorkflow management metadata

incident.io Workflows Show

Get details of a specific workflow in incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the workflow to retrieve (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
skip_step_upgradesbooleanNoSkip workflow step upgrades when existing workflow step parameters changed

Output

ParameterTypeDescription
workflowobjectThe workflow details
↳ idstringWorkflow ID
↳ namestringWorkflow name
↳ triggerstringWorkflow trigger
↳ once_forarrayFields that make the workflow run once
↳ versionnumberWorkflow version
↳ expressionsarrayWorkflow expressions
↳ condition_groupsarrayWorkflow condition groups
↳ stepsarrayWorkflow steps
↳ include_private_incidentsbooleanWhether the workflow includes private incidents
↳ include_private_escalationsbooleanWhether the workflow includes private escalations
↳ runs_on_incident_modesarrayIncident modes the workflow runs on
↳ continue_on_step_errorbooleanWhether execution continues after a step error
↳ runs_on_incidentsstringIncident lifecycle filter
↳ statestringWorkflow state (active, draft, disabled)
↳ delayobjectWorkflow delay configuration
↳ folderstringWorkflow folder
↳ runs_fromstringWhen the workflow runs from
↳ shortformstringWorkflow shortform identifier
management_metajsonWorkflow management metadata

incident.io Workflows Update

Update an existing workflow in incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the workflow to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
namestringYesNew name for the workflow (e.g., "Notify on Critical Incidents")
stepsstringYesComplete array of workflow steps as a JSON string
condition_groupsstringYesComplete array of workflow condition groups as a JSON string
runs_on_incidentsstringYesWhen to run the workflow: newly_created or newly_created_and_active
runs_on_incident_modesstringYesComplete array of incident modes to run on as a JSON string
include_private_incidentsbooleanYesWhether to include private incidents
continue_on_step_errorbooleanYesWhether to continue executing subsequent steps if a step fails
once_forstringYesComplete array of fields that make the workflow run once as a JSON string
expressionsstringYesComplete array of workflow expressions as a JSON string
statestringNoNew state for the workflow (active, draft, or disabled)
folderstringNoNew folder for the workflow
delaystringNoDelay configuration as a JSON string

Output

ParameterTypeDescription
workflowobjectThe updated workflow
↳ idstringWorkflow ID
↳ namestringWorkflow name
↳ triggerstringWorkflow trigger
↳ once_forarrayFields that make the workflow run once
↳ versionnumberWorkflow version
↳ expressionsarrayWorkflow expressions
↳ condition_groupsarrayWorkflow condition groups
↳ stepsarrayWorkflow steps
↳ include_private_incidentsbooleanWhether the workflow includes private incidents
↳ include_private_escalationsbooleanWhether the workflow includes private escalations
↳ runs_on_incident_modesarrayIncident modes the workflow runs on
↳ continue_on_step_errorbooleanWhether execution continues after a step error
↳ runs_on_incidentsstringIncident lifecycle filter
↳ statestringWorkflow state (active, draft, disabled)
↳ delayobjectWorkflow delay configuration
↳ folderstringWorkflow folder
↳ runs_fromstringWhen the workflow runs from
↳ shortformstringWorkflow shortform identifier
management_metajsonWorkflow management metadata

incident.io Workflows Delete

Delete a workflow in incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the workflow to delete (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
messagestringSuccess message

List Schedules

List all schedules in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
page_sizenumberNoNumber of results per page (e.g., 10, 25, 50). Default: 25
afterstringNoPagination cursor to fetch the next page of results (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
schedulesarrayList of schedules
↳ idstringThe schedule ID
↳ namestringThe schedule name
↳ timezonestringThe schedule timezone
↳ created_atstringWhen the schedule was created
↳ updated_atstringWhen the schedule was last updated
↳ current_shiftsarrayShifts that are ongoing right now, naming who is on call
↳ start_atstringWhen the shift starts
↳ end_atstringWhen the shift ends
↳ entry_idstringSchedule entry ID
↳ rotation_idstringRotation ID
↳ layer_idstringLayer ID
↳ userobjectThe on-call user
↳ next_shiftsarrayShifts that take over at the next changeover. Only returned when the page size is 25 or lower
↳ start_atstringWhen the shift starts
↳ end_atstringWhen the shift ends
↳ entry_idstringSchedule entry ID
↳ rotation_idstringRotation ID
↳ layer_idstringLayer ID
↳ userobjectThe on-call user
↳ permalinkstringLink to the schedule in the incident.io dashboard
↳ team_idsarrayIDs of teams that own this schedule
pagination_metaobjectPagination metadata
↳ afterstringCursor for next page
↳ page_sizenumberNumber of results per page

Create Schedule

Create a new schedule in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
namestringYesName of the schedule (e.g., "Primary On-Call")
timezonestringYesTimezone for the schedule (e.g., America/New_York)
configstringYesSchedule 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"}]}]}

Output

ParameterTypeDescription
scheduleobjectThe created schedule
↳ idstringThe schedule ID
↳ namestringThe schedule name
↳ timezonestringThe schedule timezone
↳ created_atstringWhen the schedule was created
↳ updated_atstringWhen the schedule was last updated

Show Schedule

Get details of a specific schedule in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the schedule (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
scheduleobjectThe schedule details
↳ idstringThe schedule ID
↳ namestringThe schedule name
↳ timezonestringThe schedule timezone
↳ created_atstringWhen the schedule was created
↳ updated_atstringWhen the schedule was last updated
↳ current_shiftsarrayShifts that are ongoing right now, naming who is on call
↳ start_atstringWhen the shift starts
↳ end_atstringWhen the shift ends
↳ entry_idstringSchedule entry ID
↳ rotation_idstringRotation ID
↳ layer_idstringLayer ID
↳ userobjectThe on-call user
↳ next_shiftsarrayShifts that take over at the next changeover. Only returned when the page size is 25 or lower
↳ start_atstringWhen the shift starts
↳ end_atstringWhen the shift ends
↳ entry_idstringSchedule entry ID
↳ rotation_idstringRotation ID
↳ layer_idstringLayer ID
↳ userobjectThe on-call user
↳ permalinkstringLink to the schedule in the incident.io dashboard
↳ team_idsarrayIDs of teams that own this schedule

Update Schedule

Update an existing schedule in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the schedule to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
namestringNoNew name for the schedule (e.g., "Primary On-Call")
timezonestringNoNew timezone for the schedule (e.g., America/New_York)
configstringNoSchedule 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"}]}]}

Output

ParameterTypeDescription
scheduleobjectThe updated schedule
↳ idstringThe schedule ID
↳ namestringThe schedule name
↳ timezonestringThe schedule timezone
↳ created_atstringWhen the schedule was created
↳ updated_atstringWhen the schedule was last updated

Delete Schedule

Delete a schedule in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the schedule to delete (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
messagestringSuccess message

List Escalations

List all escalation policies in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
page_sizenumberNoNumber of escalations to return per page
afterstringNoPagination cursor to fetch the next page of results

Output

ParameterTypeDescription
escalationsarrayList of escalations
↳ idstringThe escalation ID
↳ titlestringThe escalation title
↳ statusstringThe current escalation status
↳ descriptionstringAdditional detail provided with this escalation
↳ priorityobjectThe escalation priority
↳ namestringPriority name
↳ created_atstringWhen the escalation was created
↳ updated_atstringWhen the escalation was last updated
pagination_metaobjectPagination metadata
↳ afterstringCursor for next page
↳ page_sizenumberNumber of results per page

Create Escalation

Create a new escalation policy in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idempotency_keystringYesUnique identifier to prevent duplicate escalation creation. Use a UUID or unique string.
titlestringYesTitle of the escalation (e.g., "Database Critical Alert")
escalation_path_idstringNoID of the escalation path to use (required if user_ids not provided)
user_idsstringNoComma-separated list of user IDs to notify (required if escalation_path_id not provided)

Output

ParameterTypeDescription
escalationobjectThe created escalation
↳ idstringThe escalation ID
↳ titlestringThe escalation title
↳ statusstringThe current escalation status
↳ descriptionstringAdditional detail provided with this escalation
↳ priorityobjectThe escalation priority
↳ namestringPriority name
↳ created_atstringWhen the escalation was created
↳ updated_atstringWhen the escalation was last updated

Show Escalation

Get details of a specific escalation policy in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the escalation policy (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
escalationobjectThe escalation details
↳ idstringThe escalation ID
↳ titlestringThe escalation title
↳ statusstringThe current escalation status
↳ descriptionstringAdditional detail provided with this escalation
↳ priorityobjectThe escalation priority
↳ namestringPriority name
↳ created_atstringWhen the escalation was created
↳ updated_atstringWhen the escalation was last updated

incident.io Custom Fields List

List all custom fields from incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key

Output

ParameterTypeDescription
custom_fieldsarrayList of custom fields
↳ idstringCustom field ID
↳ namestringCustom field name
↳ descriptionstringCustom field description
↳ field_typestringCustom field type
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp

incident.io Custom Fields Create

Create a new custom field in incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
namestringYesName of the custom field (e.g., "Affected Service")
descriptionstringYesDescription of the custom field (required)
field_typestringYesType of the custom field: text, link, numeric, single_select, or multi_select

Output

ParameterTypeDescription
custom_fieldobjectCreated custom field
↳ idstringCustom field ID
↳ namestringCustom field name
↳ descriptionstringCustom field description
↳ field_typestringCustom field type
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp

incident.io Custom Fields Show

Get detailed information about a specific custom field from incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesCustom field ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
custom_fieldobjectCustom field details
↳ idstringCustom field ID
↳ namestringCustom field name
↳ descriptionstringCustom field description
↳ field_typestringCustom field type
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp

incident.io Custom Fields Update

Update an existing custom field in incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesCustom field ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
namestringYesNew name for the custom field (e.g., "Affected Service")
descriptionstringYesNew description for the custom field (required)

Output

ParameterTypeDescription
custom_fieldobjectUpdated custom field
↳ idstringCustom field ID
↳ namestringCustom field name
↳ descriptionstringCustom field description
↳ field_typestringCustom field type
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp

incident.io Custom Fields Delete

Delete a custom field from incident.io.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesCustom field ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
messagestringSuccess message

Incident.io Severities List

List all severity levels configured in your Incident.io workspace. Returns severity details including id, name, description, and rank.

Input

ParameterTypeRequiredDescription
apiKeystringYesIncident.io API Key

Output

ParameterTypeDescription
severitiesarrayList of severity levels
↳ idstringUnique identifier for the severity level
↳ namestringName of the severity level
↳ descriptionstringDescription of the severity level
↳ ranknumberRank/order of the severity level

Incident.io Incident Statuses List

List all incident statuses configured in your Incident.io workspace. Returns status details including id, name, description, and category.

Input

ParameterTypeRequiredDescription
apiKeystringYesIncident.io API Key

Output

ParameterTypeDescription
incident_statusesarrayList of incident statuses
↳ idstringUnique identifier for the incident status
↳ namestringName of the incident status
↳ descriptionstringDescription of the incident status
↳ categorystringCategory of the incident status

Incident.io Incident Types List

List all incident types configured in your Incident.io workspace. Returns type details including id, name, description, and default flag.

Input

ParameterTypeRequiredDescription
apiKeystringYesIncident.io API Key

Output

ParameterTypeDescription
incident_typesarrayList of incident types
↳ idstringUnique identifier for the incident type
↳ namestringName of the incident type
↳ descriptionstringDescription of the incident type
↳ is_defaultbooleanWhether this is the default incident type

List Incident Roles

List all incident roles in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key

Output

ParameterTypeDescription
incident_rolesarrayList of incident roles
↳ idstringThe incident role ID
↳ namestringThe incident role name
↳ descriptionstringThe incident role description
↳ instructionsstringInstructions for the role
↳ shortformstringShort form abbreviation of the role
↳ role_typestringThe type of role
↳ requiredbooleanWhether the role is required
↳ created_atstringWhen the role was created
↳ updated_atstringWhen the role was last updated

Create Incident Role

Create a new incident role in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
namestringYesName of the incident role (e.g., "Incident Commander")
descriptionstringYesDescription of the incident role
instructionsstringYesInstructions for the incident role
shortformstringYesShort form abbreviation for the role

Output

ParameterTypeDescription
incident_roleobjectThe created incident role
↳ idstringThe incident role ID
↳ namestringThe incident role name
↳ descriptionstringThe incident role description
↳ instructionsstringInstructions for the role
↳ shortformstringShort form abbreviation of the role
↳ role_typestringThe type of role
↳ requiredbooleanWhether the role is required
↳ created_atstringWhen the role was created
↳ updated_atstringWhen the role was last updated

Show Incident Role

Get details of a specific incident role in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the incident role (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
incident_roleobjectThe incident role details
↳ idstringThe incident role ID
↳ namestringThe incident role name
↳ descriptionstringThe incident role description
↳ instructionsstringInstructions for the role
↳ shortformstringShort form abbreviation of the role
↳ role_typestringThe type of role
↳ requiredbooleanWhether the role is required
↳ created_atstringWhen the role was created
↳ updated_atstringWhen the role was last updated

Update Incident Role

Update an existing incident role in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the incident role to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
namestringYesName of the incident role (e.g., "Incident Commander")
descriptionstringYesDescription of the incident role
instructionsstringYesInstructions for the incident role
shortformstringYesShort form abbreviation for the role

Output

ParameterTypeDescription
incident_roleobjectThe updated incident role
↳ idstringThe incident role ID
↳ namestringThe incident role name
↳ descriptionstringThe incident role description
↳ instructionsstringInstructions for the role
↳ shortformstringShort form abbreviation of the role
↳ role_typestringThe type of role
↳ requiredbooleanWhether the role is required
↳ created_atstringWhen the role was created
↳ updated_atstringWhen the role was last updated

Delete Incident Role

Delete an incident role in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the incident role to delete (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
messagestringSuccess message

List Incident Timestamps

List all incident timestamp definitions in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key

Output

ParameterTypeDescription
incident_timestampsarrayList of incident timestamp definitions
↳ idstringThe timestamp ID
↳ namestringThe timestamp name
↳ ranknumberThe rank/order of the timestamp
↳ created_atstringWhen the timestamp was created
↳ updated_atstringWhen the timestamp was last updated

Show Incident Timestamp

Get details of a specific incident timestamp definition in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the incident timestamp (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
incident_timestampobjectThe incident timestamp details
↳ idstringThe timestamp ID
↳ namestringThe timestamp name
↳ ranknumberThe rank/order of the timestamp
↳ created_atstringWhen the timestamp was created
↳ updated_atstringWhen the timestamp was last updated

List Incident Updates

List all updates for a specific incident in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
incident_idstringNoThe ID of the incident to get updates for (e.g., "01FCNDV6P870EA6S7TK1DSYDG0"). If not provided, returns all updates
page_sizenumberNoNumber of results to return per page (e.g., 10, 25, 50)
afterstringNoCursor for pagination (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
incident_updatesarrayList of incident updates
↳ idstringThe update ID
↳ incident_idstringThe incident ID
↳ messagestringThe update message
↳ merged_into_incident_idstringID of the incident this incident was merged into
↳ new_severityobjectNew severity if changed
↳ idstringSeverity ID
↳ namestringSeverity name
↳ ranknumberSeverity rank
↳ new_incident_statusobjectThe incident status after this update
↳ idstringStatus ID
↳ namestringStatus name
↳ categorystringStatus category
↳ updaterobjectActor who created the update
↳ userobjectSet when a user made the update
↳ idstringUser ID
↳ namestringUser name
↳ emailstringUser email
↳ api_keyobjectSet when an API key made the update
↳ idstringAPI key ID
↳ namestringAPI key name
↳ workflowobjectSet when a workflow made the update
↳ idstringWorkflow ID
↳ namestringWorkflow name
↳ alertobjectSet when an alert made the update
↳ idstringAlert ID
↳ titlestringAlert title
↳ created_atstringWhen the update was created
pagination_metaobjectPagination information
↳ afterstringCursor for next page
↳ page_sizenumberNumber of results per page

List Schedule Entries

List all entries for a specific schedule in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
schedule_idstringYesThe ID of the schedule to get entries for (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
entry_window_startstringNoStart date/time to filter entries in ISO 8601 format (e.g., "2024-01-15T09:00:00Z")
entry_window_endstringNoEnd date/time to filter entries in ISO 8601 format (e.g., "2024-01-22T09:00:00Z")

Output

ParameterTypeDescription
schedule_entriesobjectSchedule entries grouped by final, overrides, and scheduled entries
↳ finalarrayFinal computed schedule entries
↳ overridesarrayOverride schedule entries
↳ scheduledarrayScheduled entries before overrides are applied
pagination_metaobjectPagination information
↳ afterstringCursor for next page
↳ after_urlstringURL for next page

Create Schedule Override

Create a new schedule override in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
rotation_idstringYesThe ID of the rotation to override (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
layer_idstringYesThe ID of the layer this override applies to
schedule_idstringYesThe ID of the schedule (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
user_idstringNoThe ID of the user to assign (provide one of: user_id, user_email, or user_slack_id)
user_emailstringNoThe email of the user to assign (provide one of: user_id, user_email, or user_slack_id)
user_slack_idstringNoThe Slack ID of the user to assign (provide one of: user_id, user_email, or user_slack_id)
start_atstringYesWhen the override starts in ISO 8601 format (e.g., "2024-01-15T09:00:00Z")
end_atstringYesWhen the override ends in ISO 8601 format (e.g., "2024-01-22T09:00:00Z")

Output

ParameterTypeDescription
overrideobjectThe created schedule override
↳ idstringThe override ID
↳ layer_idstringThe schedule layer ID
↳ rotation_idstringThe rotation ID
↳ schedule_idstringThe schedule ID
↳ userobjectUser assigned to this override
↳ idstringUser ID
↳ namestringUser name
↳ emailstringUser email
↳ start_atstringWhen the override starts
↳ end_atstringWhen the override ends
↳ created_atstringWhen the override was created
↳ updated_atstringWhen the override was last updated

List Escalation Paths

List escalation paths in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
page_sizenumberNoNumber of escalation paths to return per page
afterstringNoPagination cursor to fetch the next page of results

Output

ParameterTypeDescription
escalation_pathsarrayList of escalation paths
↳ idstringThe escalation path ID
↳ namestringThe escalation path name
↳ patharrayArray of escalation levels
↳ working_hoursarrayWorking hours configuration
pagination_metaobjectPagination metadata
↳ afterstringCursor for next page
↳ page_sizenumberNumber of results per page

Create Escalation Path

Create a new escalation path in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
namestringYesName of the escalation path (e.g., "Critical Incident Path")
pathjsonYesArray 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_hoursjsonNoOptional working hours configuration. Array of {weekday, start_time, end_time}

Output

ParameterTypeDescription
escalation_pathobjectThe created escalation path
↳ idstringThe escalation path ID
↳ namestringThe escalation path name
↳ patharrayArray of escalation levels
↳ targetsarrayTargets for this level
↳ idstringTarget ID
↳ typestringTarget type
↳ schedule_idstringSchedule ID if type is schedule
↳ user_idstringUser ID if type is user
↳ urgencystringUrgency level
↳ time_to_ack_secondsnumberTime to acknowledge in seconds
↳ working_hoursarrayWorking hours configuration
↳ weekdaystringDay of week
↳ start_timestringStart time
↳ end_timestringEnd time

Show Escalation Path

Get details of a specific escalation path in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the escalation path (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
escalation_pathobjectThe escalation path details
↳ idstringThe escalation path ID
↳ namestringThe escalation path name
↳ patharrayArray of escalation levels
↳ targetsarrayTargets for this level
↳ idstringTarget ID
↳ typestringTarget type
↳ schedule_idstringSchedule ID if type is schedule
↳ user_idstringUser ID if type is user
↳ urgencystringUrgency level
↳ time_to_ack_secondsnumberTime to acknowledge in seconds
↳ working_hoursarrayWorking hours configuration
↳ weekdaystringDay of week
↳ start_timestringStart time
↳ end_timestringEnd time

Update Escalation Path

Update an existing escalation path in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the escalation path to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
namestringYesNew name for the escalation path (e.g., "Critical Incident Path")
pathjsonYesNew escalation path configuration. Array of escalation levels with targets and time_to_ack_seconds
working_hoursjsonNoNew working hours configuration. Array of {weekday, start_time, end_time}

Output

ParameterTypeDescription
escalation_pathobjectThe updated escalation path
↳ idstringThe escalation path ID
↳ namestringThe escalation path name
↳ patharrayArray of escalation levels
↳ targetsarrayTargets for this level
↳ idstringTarget ID
↳ typestringTarget type
↳ schedule_idstringSchedule ID if type is schedule
↳ user_idstringUser ID if type is user
↳ urgencystringUrgency level
↳ time_to_ack_secondsnumberTime to acknowledge in seconds
↳ working_hoursarrayWorking hours configuration
↳ weekdaystringDay of week
↳ start_timestringStart time
↳ end_timestringEnd time

Delete Escalation Path

Delete an escalation path in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the escalation path to delete (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
messagestringSuccess message

Get Who Is On Call

Get who is currently on call in incident.io, as one row per ongoing shift across every schedule (or a single schedule). Also returns the shifts that take over at the next changeover.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
schedule_idstringNoLimit the result to a single schedule by ID (e.g., "01FCNDV6P870EA6S7TK1DSYDG0"). Leave empty to return who is on call across every schedule.
page_sizenumberNoNumber of schedules to scan per page when no schedule ID is given (e.g., 10, 25). Defaults to 25; upcoming shifts are only returned at 25 or lower.
afterstringNoPagination cursor to fetch the next page of schedules (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
on_callarrayShifts that are ongoing right now, one row per on-call person per schedule
next_on_callarrayShifts that take over at the next changeover. Only populated when the page size is 25 or lower
pagination_metaobjectPagination metadata, returned when scanning every schedule
↳ afterstringCursor for next page
↳ page_sizenumberNumber of results per page
↳ total_record_countnumberTotal number of schedules

List Schedule Overrides

List the one-off overrides layered on top of a schedule in incident.io, such as someone covering a colleague’s shift

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
schedule_idstringYesThe ID of the schedule to get overrides for (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
rotation_idstringNoOnly return overrides on this rotation
layer_idstringNoOnly return overrides on this layer
page_sizenumberNoNumber of results per page (e.g., 10, 25, 50)
afterstringNoPagination cursor to fetch the next page of results (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
overridesarrayList of schedule overrides
↳ idstringOverride ID
↳ schedule_idstringSchedule the override applies to
↳ rotation_idstringRotation the override applies to
↳ layer_idstringLayer the override applies to
↳ start_atstringStart of the override
↳ end_atstringEnd of the override
↳ created_atstringWhen the override was created
↳ updated_atstringWhen the override was last updated
↳ userobjectThe user covering the override
↳ idstringUser ID
↳ namestringUser display name
↳ emailstringUser email address
↳ rolestringUser role
↳ slack_user_idstringSlack user ID
pagination_metaobjectPagination metadata
↳ afterstringCursor for next page
↳ page_sizenumberNumber of results per page

List Alerts

List alerts in incident.io, optionally filtered by status, source, or created date

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
page_sizenumberNoNumber of results per page (e.g., 10, 25, 50). Default: 25
afterstringNoPagination cursor to fetch the next page of results (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
statusstringNoFilter by alert status: "firing" or "resolved"
status_operatorstringNoHow to apply the status filter: "one_of" to match it, "not_in" to exclude it. Default: one_of
alert_source_idstringNoFilter by alert source ID (e.g., "01GBSQF3FHF7FWZQNWGHAVQ804")
alert_source_operatorstringNoHow to apply the alert source filter: "one_of" to match it, "not_in" to exclude it. Default: one_of
deduplication_keystringNoFilter to the single alert with this deduplication key
created_at_gtestringNoOnly return alerts created on or after this date (e.g., "2025-01-01")
created_at_ltestringNoOnly return alerts created on or before this date (e.g., "2025-02-01")
has_notesbooleanNoFilter to alerts that do (true) or do not (false) have notes attached
include_maintenance_windowbooleanNoWhether to include alerts held by a maintenance window. Defaults to true on the API

Output

ParameterTypeDescription
alertsarrayList of alerts
↳ idstringAlert ID
↳ titlestringAlert title, parsed from the alert payload
↳ statusstringAlert status (firing, resolved)
↳ alert_source_idstringID of the alert source this alert fired on
↳ deduplication_keystringKey that uniquely references this alert from its source
↳ descriptionstringAlert description
↳ source_urlstringLink to the alert in the upstream system
↳ resolved_atstringWhen this alert was resolved
↳ created_atstringWhen this alert was created
↳ updated_atstringWhen this alert was last updated
↳ alert_group_idsarrayIDs of every alert group this alert belongs to
↳ attributesarrayAttribute values parsed from the alert payload
pagination_metaobjectPagination metadata
↳ afterstringCursor for next page
↳ page_sizenumberNumber of results per page

Show Alert

Get a single alert by ID from incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the alert to fetch (e.g., "01GW2G3V0S59R238FAHPDS1R66")

Output

ParameterTypeDescription
alertobjectThe alert details
↳ idstringAlert ID
↳ titlestringAlert title, parsed from the alert payload
↳ statusstringAlert status (firing, resolved)
↳ alert_source_idstringID of the alert source this alert fired on
↳ deduplication_keystringKey that uniquely references this alert from its source
↳ descriptionstringAlert description
↳ source_urlstringLink to the alert in the upstream system
↳ resolved_atstringWhen this alert was resolved
↳ created_atstringWhen this alert was created
↳ updated_atstringWhen this alert was last updated
↳ alert_group_idsarrayIDs of every alert group this alert belongs to
↳ attributesarrayAttribute values parsed from the alert payload

Resolve Alert

Resolve a currently firing alert in incident.io. Resolving an already-resolved alert is a no-op and returns it unchanged.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the alert to resolve (e.g., "01GW2G3V0S59R238FAHPDS1R66")

Output

ParameterTypeDescription
alertobjectThe resolved alert
↳ idstringAlert ID
↳ titlestringAlert title, parsed from the alert payload
↳ statusstringAlert status (firing, resolved)
↳ alert_source_idstringID of the alert source this alert fired on
↳ deduplication_keystringKey that uniquely references this alert from its source
↳ descriptionstringAlert description
↳ source_urlstringLink to the alert in the upstream system
↳ resolved_atstringWhen this alert was resolved
↳ created_atstringWhen this alert was created
↳ updated_atstringWhen this alert was last updated
↳ alert_group_idsarrayIDs of every alert group this alert belongs to
↳ attributesarrayAttribute values parsed from the alert payload

Create Alert Event

Fire an alert into incident.io through an HTTP alert source. Send the same deduplication key with status "resolved" to close the alert you opened.

Input

ParameterTypeRequiredDescription
alert_source_config_idstringYesThe ID of the HTTP alert source config to fire into (e.g., "01GW2G3V0S59R238FAHPDS1R66")
alert_source_tokenstringYesThe token generated when configuring the HTTP alert source. This is not the incident.io API key.
titlestringYesTitle of the alert (e.g., "Payments service error rate above 5%")
statusstringYesCurrent status of the alert: "firing" or "resolved"
descriptionstringNoDetail to add below the title. Supports Markdown.
deduplication_keystringNoKey that uniquely identifies this alert. Reuse it to update or resolve the same alert instead of creating a new one.
source_urlstringNoLink back to the alert in the upstream system
metadatastringNoAdditional metadata as a JSON object, parsed according to the alert source config (e.g., {"service": "payments"})

Output

ParameterTypeDescription
deduplication_keystringThe deduplication key the event was processed with
messagestringHuman readable message giving detail about the event
statusstringStatus of the event

List Incident Alerts

List the connections between incidents and alerts in incident.io — which alerts triggered an incident, or which incident an alert was attached to

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
page_sizenumberNoNumber of results per page (e.g., 10, 25, 50). Default: 25
afterstringNoPagination cursor to fetch the next page of results (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
incident_idstringNoOnly return alerts attached to this incident (e.g., "01FDAG4SAP5TYPT98WGR2N7W91")
alert_idstringNoOnly return connections for this alert (e.g., "01GW2G3V0S59R238FAHPDS1R66")

Output

ParameterTypeDescription
incident_alertsarrayList of incident-to-alert connections
↳ idstringID of this incident alert connection
↳ alert_route_idstringID of the alert route that created this connection
↳ alertobjectThe connected alert
↳ idstringAlert ID
↳ titlestringAlert title
↳ statusstringAlert status (firing, resolved)
↳ alert_source_idstringID of the alert source this alert fired on
↳ deduplication_keystringKey that uniquely references this alert from its source
↳ descriptionstringAlert description
↳ source_urlstringLink to the alert in the upstream system
↳ resolved_atstringWhen this alert was resolved
↳ created_atstringWhen this alert was created
↳ updated_atstringWhen this alert was last updated
↳ incidentobjectThe incident the alert is attached to
↳ idstringIncident ID
↳ namestringIncident name
↳ referencestringIncident reference (e.g., INC-123)
↳ external_idnumberExternal incident identifier
↳ status_categorystringCategory of the incident status
↳ visibilitystringIncident visibility (public, private)
↳ summarystringIncident summary
pagination_metaobjectPagination metadata
↳ afterstringCursor for next page
↳ page_sizenumberNumber of results per page

Cancel Escalation

Cancel an escalation in incident.io. Notifications stop, and the escalation will not advance to further levels or repeat.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the escalation to cancel (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
messagestringSuccess message

List Catalog Types

List all catalog types in incident.io, including those synced from external resources. Use this to find the catalog type ID needed to list entries.

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key

Output

ParameterTypeDescription
catalog_typesarrayList of catalog types
↳ idstringCatalog type ID
↳ namestringHuman readable name of this type
↳ descriptionstringHuman readable description of this type
↳ type_namestringType name used when defining attributes (e.g., Custom["Service"])
↳ engine_resource_typestringHow this resource type is referenced in the incident.io engine
↳ categoriesarrayCategories this type is considered part of
↳ colorstringDisplay color of this type in the dashboard
↳ iconstringDisplay icon of this type in the dashboard
↳ rankedbooleanWhether entries of this type are ranked
↳ is_editablebooleanWhether this type can be edited (types synced externally cannot)
↳ use_name_as_identifierbooleanWhether entries can be referenced by name as well as external ID
↳ estimated_countnumberEstimated number of entries for this type
↳ is_team_typebooleanWhether this is the designated team type in team settings
↳ registry_typestringThe registry resource this type is synced from, if any
↳ last_synced_atstringWhen this type was last synced
↳ owning_team_idsarrayIDs of the teams that own this catalog type
↳ schemaobjectAttribute schema for this catalog type
↳ versionnumberVersion number of this schema
↳ attributesarrayAttributes of this catalog type
↳ annotationsjsonMetadata annotations tracked about this type
↳ created_atstringWhen this type was created
↳ updated_atstringWhen this type was last updated

List Catalog Entries

List the entries of a catalog type in incident.io — for example every service, team, or customer recorded in the catalog

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
catalog_type_idstringYesThe ID of the catalog type to list entries for (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
page_sizenumberNoNumber of results per page (e.g., 10, 25, 50). Default: 25
afterstringNoPagination cursor to fetch the next page of results (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
identifierstringNoOnly return entries matching this identifier. Searches by ID, external ID, and alias.

Output

ParameterTypeDescription
catalog_entriesarrayList of catalog entries
↳ idstringCatalog entry ID
↳ namestringHuman readable name of this entry
↳ catalog_type_idstringID of the catalog type
↳ external_idstringAlternative ID for this entry, unique within the type
↳ aliasesarrayAlternative names this entry can be referenced by
↳ ranknumberOrdering rank, used when the type is ranked
↳ attribute_valuesjsonAttribute values of this entry
↳ archived_atstringWhen this entry was archived
↳ created_atstringWhen this entry was created
↳ updated_atstringWhen this entry was last updated
catalog_typeobjectThe catalog type these entries belong to
↳ idstringCatalog type ID
↳ namestringHuman readable name of this type
↳ descriptionstringHuman readable description of this type
↳ type_namestringType name used when defining attributes (e.g., Custom["Service"])
↳ engine_resource_typestringHow this resource type is referenced in the incident.io engine
↳ categoriesarrayCategories this type is considered part of
↳ colorstringDisplay color of this type in the dashboard
↳ iconstringDisplay icon of this type in the dashboard
↳ rankedbooleanWhether entries of this type are ranked
↳ is_editablebooleanWhether this type can be edited (types synced externally cannot)
↳ use_name_as_identifierbooleanWhether entries can be referenced by name as well as external ID
↳ estimated_countnumberEstimated number of entries for this type
↳ is_team_typebooleanWhether this is the designated team type in team settings
↳ registry_typestringThe registry resource this type is synced from, if any
↳ last_synced_atstringWhen this type was last synced
↳ owning_team_idsarrayIDs of the teams that own this catalog type
↳ schemaobjectAttribute schema for this catalog type
↳ versionnumberVersion number of this schema
↳ attributesarrayAttributes of this catalog type
↳ annotationsjsonMetadata annotations tracked about this type
↳ created_atstringWhen this type was created
↳ updated_atstringWhen this type was last updated
pagination_metaobjectPagination metadata
↳ afterstringCursor for next page
↳ page_sizenumberNumber of results per page
↳ total_record_countnumberTotal number of entries

List Teams

List all teams in the incident.io organisation, along with their members

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
page_sizenumberNoNumber of results per page (e.g., 10, 25, 50)
afterstringNoPagination cursor to fetch the next page of results (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
teamsarrayList of teams
↳ idstringTeam ID
↳ namestringTeam name
↳ membersarrayMembers of the team
↳ idstringUser ID
↳ namestringUser display name
↳ emailstringUser email address
↳ slack_user_idstringSlack user ID
↳ catalog_entryobjectThe catalog entry backing this team
↳ idstringCatalog entry ID
↳ namestringCatalog entry name
↳ external_idstringAlternative ID for this entry, unique within the type
pagination_metaobjectPagination metadata
↳ afterstringCursor for next page
↳ page_sizenumberNumber of results per page

Show Team

Get a single team by ID from incident.io, along with its members

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the team to fetch (e.g., "01JPQA75EPNEES4479P16P4XAB")

Output

ParameterTypeDescription
teamobjectThe team details
↳ idstringTeam ID
↳ namestringTeam name
↳ membersarrayMembers of the team
↳ idstringUser ID
↳ namestringUser display name
↳ emailstringUser email address
↳ slack_user_idstringSlack user ID
↳ catalog_entryobjectThe catalog entry backing this team
↳ idstringCatalog entry ID
↳ namestringCatalog entry name
↳ external_idstringAlternative ID for this entry, unique within the type

Create Follow-up

Create a new follow-up on an incident in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
incident_idstringYesThe ID of the incident the follow-up belongs to (e.g., "01FDAG4SAP5TYPT98WGR2N7W91")
titlestringYesTitle of the follow-up (e.g., "Add alerting on connection pool saturation")
descriptionstringNoDescription of the follow-up. Supports Markdown.
assignee_idstringNoID of the user to assign this follow-up to
assignee_team_idstringNoID of the team to assign this follow-up to
follow_up_category_idstringNoID of the category for this follow-up
follow_up_priority_option_idstringNoID of the priority for this follow-up
external_issue_reference_idstringNoID of the external issue this follow-up relates to
labelsstringNoComma-separated list of labels (e.g., "bug,urgent")

Output

ParameterTypeDescription
follow_upobjectThe created follow-up
↳ idstringFollow-up ID
↳ incident_idstringID of the incident the follow-up belongs to
↳ titlestringFollow-up title
↳ statusstringFollow-up status (outstanding, completed, deleted, not_doing)
↳ descriptionstringFollow-up description
↳ labelsarrayLabels associated with this follow-up
↳ assignee_teamobjectThe team the follow-up is assigned to
↳ idstringTeam ID
↳ namestringTeam name
↳ priorityobjectFollow-up priority
↳ idstringPriority ID
↳ namestringPriority name
↳ ranknumberPriority rank
↳ descriptionstringPriority description
↳ creatorobjectWho created the follow-up
↳ completed_atstringWhen the follow-up was completed
↳ created_atstringWhen the follow-up was created
↳ updated_atstringWhen the follow-up was last updated

Update Follow-up

Update an existing follow-up in incident.io, for example to mark it completed or reassign it

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the follow-up to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
titlestringYesTitle of the follow-up. This endpoint replaces the title, so always send it.
statusstringYesStatus of the follow-up: "outstanding", "completed", or "not_doing". Deleting is not supported here.
descriptionstringNoDescription of the follow-up. Supports Markdown.
assignee_idstringNoID of the user to assign this follow-up to
assignee_team_idstringNoID of the team to assign this follow-up to
follow_up_category_idstringNoID of the category for this follow-up
follow_up_priority_option_idstringNoID of the priority for this follow-up
labelsstringNoComma-separated list of labels (e.g., "bug,urgent")

Output

ParameterTypeDescription
follow_upobjectThe updated follow-up
↳ idstringFollow-up ID
↳ incident_idstringID of the incident the follow-up belongs to
↳ titlestringFollow-up title
↳ statusstringFollow-up status (outstanding, completed, deleted, not_doing)
↳ descriptionstringFollow-up description
↳ labelsarrayLabels associated with this follow-up
↳ assignee_teamobjectThe team the follow-up is assigned to
↳ idstringTeam ID
↳ namestringTeam name
↳ priorityobjectFollow-up priority
↳ idstringPriority ID
↳ namestringPriority name
↳ ranknumberPriority rank
↳ descriptionstringPriority description
↳ creatorobjectWho created the follow-up
↳ completed_atstringWhen the follow-up was completed
↳ created_atstringWhen the follow-up was created
↳ updated_atstringWhen the follow-up was last updated

Create Action

Create a new action on an incident in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
incident_idstringYesThe ID of the incident the action belongs to (e.g., "01FDAG4SAP5TYPT98WGR2N7W91")
descriptionstringYesDescription of the action. Supports Markdown.
assignee_idstringNoID of the user to assign this action to

Output

ParameterTypeDescription
actionobjectThe created action
↳ idstringAction ID
↳ incident_idstringID of the incident the action belongs to
↳ descriptionstringAction description
↳ statusstringAction status (outstanding, completed, deleted, not_doing)
↳ creatorobjectWho created the action
↳ completed_atstringWhen the action was completed
↳ created_atstringWhen the action was created
↳ updated_atstringWhen the action was last updated

Update Action

Update an existing action in incident.io, for example to mark it completed or reassign it

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
idstringYesThe ID of the action to update (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")
descriptionstringYesDescription of the action. This endpoint replaces the description, so always send it.
statusstringYesStatus of the action: "outstanding", "completed", or "not_doing". Deleting is not supported here.
assignee_idstringNoID of the user to assign this action to

Output

ParameterTypeDescription
actionobjectThe updated action
↳ idstringAction ID
↳ incident_idstringID of the incident the action belongs to
↳ descriptionstringAction description
↳ statusstringAction status (outstanding, completed, deleted, not_doing)
↳ creatorobjectWho created the action
↳ completed_atstringWhen the action was completed
↳ created_atstringWhen the action was created
↳ updated_atstringWhen the action was last updated

List Incident Participants

List the participants of an incident in incident.io, split into those actively helping and those just observing

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
incident_idstringYesThe ID of the incident to find participants of (e.g., "01FDAG4SAP5TYPT98WGR2N7W91")

Output

ParameterTypeDescription
activearrayParticipants who are actively helping with the incident
passivearrayParticipants who are just observing the incident

Grant Incident Membership

Make a user a member of a private incident in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
incident_idstringYesThe ID of the private incident (e.g., "01FCNDV6P870EA6S7TK1DSYD5H")
user_idstringYesThe ID of the user to grant access to (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
incident_membershipobjectThe created incident membership
↳ idstringIncident membership ID
↳ incident_idstringID of the incident
↳ created_atstringWhen the membership was created
↳ updated_atstringWhen the membership was last updated
↳ userobjectThe user who was granted access
↳ idstringUser ID
↳ namestringUser display name
↳ emailstringUser email address
↳ rolestringUser role
↳ slack_user_idstringSlack user ID

Revoke Incident Membership

Revoke a user's membership of a private incident in incident.io

Input

ParameterTypeRequiredDescription
apiKeystringYesincident.io API Key
incident_idstringYesThe ID of the private incident (e.g., "01FCNDV6P870EA6S7TK1DSYD5H")
user_idstringYesThe ID of the user to revoke access from (e.g., "01FCNDV6P870EA6S7TK1DSYDG0")

Output

ParameterTypeDescription
messagestringSuccess message

Triggers

A Trigger is a block that starts a workflow when an event happens in this service.

incident.io Alert Created

Trigger workflow when an alert is created in incident.io

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesThe signing secret from your incident.io webhook endpoint. Used to verify events.

Output

ParameterTypeDescription
event_typestringincident.io event type (e.g., public_incident.incident_created_v2). Top-level event_type field.
payloadjsonFull raw webhook body as delivered by incident.io (the entire Svix envelope).
alertjsonThe full alert object from the webhook payload.
alert_idstringUnique alert ID.
titlestringAlert title.
descriptionstringAlert description, when set.
statusstringAlert status (e.g., firing, resolved).
alert_source_idstringID of the alert source that raised the alert.
deduplication_keystringDeduplication key for the alert, when set.
source_urlstringURL to the alert in the originating system, when set.
created_atstringISO 8601 timestamp when the alert was created.
updated_atstringISO 8601 timestamp when the alert was last updated.
resolved_atstringISO 8601 timestamp when the alert was resolved, when applicable.

incident.io Incident Created

Trigger workflow when an incident is created in incident.io

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesThe signing secret from your incident.io webhook endpoint. Used to verify events.

Output

ParameterTypeDescription
event_typestringincident.io event type (e.g., public_incident.incident_created_v2). Top-level event_type field.
payloadjsonFull raw webhook body as delivered by incident.io (the entire Svix envelope).
incidentjsonThe full incident object from the webhook payload.
incident_idstringUnique incident ID (e.g., 01FDAG4SAP5TYPT98WGR2N7W91).
namestringIncident name.
referencestringHuman-readable incident reference (e.g., INC-123).
summarystringIncident summary, when set.
incident_statusjsonThe incident status object (id, name, category, rank).
severityjsonThe incident severity object (id, name, rank), when set.
modestringIncident mode (standard, retrospective, test, tutorial, stream).
visibilitystringIncident visibility (public or private).
permalinkstringLink to the incident in incident.io, when present.
created_atstringISO 8601 timestamp when the incident was created.
updated_atstringISO 8601 timestamp when the incident was last updated.
new_statusjsonNew status object (status-updated events only; null otherwise).
previous_statusjsonPrevious status object (status-updated events only; null otherwise).
update_messagestringUpdate message accompanying a status change (status-updated events only; null otherwise).

incident.io Incident Status Updated

Trigger workflow when an incident

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesThe signing secret from your incident.io webhook endpoint. Used to verify events.

Output

ParameterTypeDescription
event_typestringincident.io event type (e.g., public_incident.incident_created_v2). Top-level event_type field.
payloadjsonFull raw webhook body as delivered by incident.io (the entire Svix envelope).
incidentjsonThe full incident object from the webhook payload.
incident_idstringUnique incident ID (e.g., 01FDAG4SAP5TYPT98WGR2N7W91).
namestringIncident name.
referencestringHuman-readable incident reference (e.g., INC-123).
summarystringIncident summary, when set.
incident_statusjsonThe incident status object (id, name, category, rank).
severityjsonThe incident severity object (id, name, rank), when set.
modestringIncident mode (standard, retrospective, test, tutorial, stream).
visibilitystringIncident visibility (public or private).
permalinkstringLink to the incident in incident.io, when present.
created_atstringISO 8601 timestamp when the incident was created.
updated_atstringISO 8601 timestamp when the incident was last updated.
new_statusjsonNew status object (status-updated events only; null otherwise).
previous_statusjsonPrevious status object (status-updated events only; null otherwise).
update_messagestringUpdate message accompanying a status change (status-updated events only; null otherwise).

incident.io Incident Updated

Trigger workflow when an incident is updated in incident.io

Configuration

ParameterTypeRequiredDescription
signingSecretstringYesThe signing secret from your incident.io webhook endpoint. Used to verify events.

Output

ParameterTypeDescription
event_typestringincident.io event type (e.g., public_incident.incident_created_v2). Top-level event_type field.
payloadjsonFull raw webhook body as delivered by incident.io (the entire Svix envelope).
incidentjsonThe full incident object from the webhook payload.
incident_idstringUnique incident ID (e.g., 01FDAG4SAP5TYPT98WGR2N7W91).
namestringIncident name.
referencestringHuman-readable incident reference (e.g., INC-123).
summarystringIncident summary, when set.
incident_statusjsonThe incident status object (id, name, category, rank).
severityjsonThe incident severity object (id, name, rank), when set.
modestringIncident mode (standard, retrospective, test, tutorial, stream).
visibilitystringIncident visibility (public or private).
permalinkstringLink to the incident in incident.io, when present.
created_atstringISO 8601 timestamp when the incident was created.
updated_atstringISO 8601 timestamp when the incident was last updated.
new_statusjsonNew status object (status-updated events only; null otherwise).
previous_statusjsonPrevious status object (status-updated events only; null otherwise).
update_messagestringUpdate message accompanying a status change (status-updated events only; null otherwise).