Edit Incident

Edit an existing incident.

This endpoint allows you to edit the properties of an existing incident: e.g. set the severity or update custom fields.

When using this endpoint, only fields that are provided will be edited (omitted fields will be ignored).

External Documentation

To learn more, visit the incident.io documentation.

Parameters

Parameter	Description
Call URL	The call URL attached to this incident.
Custom Field Entries	Set the incident's custom fields to these values.
Incident ID	The unique identifier of the incident that you want to edit.
Incident Role Assignments	Assign incident roles to these people.
Incident Status ID	Incident status to change incident to (you can only change an incident from one active status to another, any other lifecycle changes must be taken via the app.).
Incident Timestamp Values	Assign the incident's timestamps to these values.
Name	Explanation of the incident.
Notify Incident Channel	Should we send Slack channel notifications to inform responders of this update? Note that this won't work if the Slack channel has already been archived.
Severity ID	Severity to change incident to.
Summary	Detailed description of the incident.

Example Output

{
    "incident": {
        "call_url": "https://zoom.us/foo",
        "created_at": "2021-08-17T13:28:57.801578Z",
        "creator": {
            "api_key": {
                "id": "01FCNDV6P870EA6S7TK1DSYDG0",
                "name": "My test API key"
            },
            "user": {
                "email": "lisa@incident.io",
                "id": "01FCNDV6P870EA6S7TK1DSYDG0",
                "name": "Lisa Karlin Curtis",
                "role": "viewer",
                "slack_user_id": "U02AYNF2XJM"
            }
        },
        "custom_field_entries": [
            {
                "custom_field": {
                    "description": "Which team is impacted by this issue",
                    "field_type": "single_select",
                    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
                    "name": "Affected Team",
                    "options": [
                        {
                            "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0",
                            "id": "01FCNDV6P870EA6S7TK1DSYDG0",
                            "sort_key": 10,
                            "value": "Product"
                        }
                    ]
                },
                "values": [
                    {
                        "value_catalog_entry": {
                            "aliases": [
                                "lawrence@incident.io",
                                "lawrence"
                            ],
                            "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33",
                            "id": "01FCNDV6P870EA6S7TK1DSYDG0",
                            "name": "Primary On-call"
                        },
                        "value_link": "https://google.com/",
                        "value_numeric": "123.456",
                        "value_option": {
                            "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0",
                            "id": "01FCNDV6P870EA6S7TK1DSYDG0",
                            "sort_key": 10,
                            "value": "Product"
                        },
                        "value_text": "This is my text field, I hope you like it"
                    }
                ]
            }
        ],
        "duration_metrics": [
            {
                "duration_metric": {
                    "id": "01FCNDV6P870EA6S7TK1DSYD5H",
                    "name": "Lasted"
                },
                "value_seconds": 1
            }
        ],
        "external_issue_reference": {
            "issue_name": "INC-123",
            "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up",
            "provider": "asana"
        },
        "id": "01FDAG4SAP5TYPT98WGR2N7W91",
        "incident_role_assignments": [
            {
                "assignee": {
                    "email": "lisa@incident.io",
                    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
                    "name": "Lisa Karlin Curtis",
                    "role": "viewer",
                    "slack_user_id": "U02AYNF2XJM"
                },
                "role": {
                    "created_at": "2021-08-17T13:28:57.801578Z",
                    "description": "The person currently coordinating the incident",
                    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
                    "instructions": "Take point on the incident; Make sure people are clear on responsibilities",
                    "name": "Incident Lead",
                    "required": false,
                    "role_type": "lead",
                    "shortform": "lead",
                    "updated_at": "2021-08-17T13:28:57.801578Z"
                }
            }
        ],
        "incident_status": {
            "category": "triage",
            "created_at": "2021-08-17T13:28:57.801578Z",
            "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.",
            "id": "01FCNDV6P870EA6S7TK1DSYD5H",
            "name": "Closed",
            "rank": 4,
            "updated_at": "2021-08-17T13:28:57.801578Z"
        },
        "incident_timestamp_values": [
            {
                "incident_timestamp": {
                    "id": "01FCNDV6P870EA6S7TK1DSYD5H",
                    "name": "Impact started",
                    "rank": 1
                },
                "value": {
                    "value": "2021-08-17T13:28:57.801578Z"
                }
            }
        ],
        "incident_type": {
            "create_in_triage": "always",
            "created_at": "2021-08-17T13:28:57.801578Z",
            "description": "Customer facing production outages",
            "id": "01FCNDV6P870EA6S7TK1DSYDG0",
            "is_default": false,
            "name": "Production Outage",
            "private_incidents_only": false,
            "updated_at": "2021-08-17T13:28:57.801578Z"
        },
        "mode": "standard",
        "name": "Our database is sad",
        "permalink": "https://app.incident.io/incidents/123",
        "postmortem_document_url": "https://docs.google.com/my_doc_id",
        "reference": "INC-123",
        "severity": {
            "created_at": "2021-08-17T13:28:57.801578Z",
            "description": "Issues with **low impact**.",
            "id": "01FCNDV6P870EA6S7TK1DSYDG0",
            "name": "Minor",
            "rank": 1,
            "updated_at": "2021-08-17T13:28:57.801578Z"
        },
        "slack_channel_id": "C02AW36C1M5",
        "slack_channel_name": "inc-165-green-parrot",
        "slack_team_id": "T02A1FSLE8J",
        "summary": "Our database is really really sad, and we don't know why yet.",
        "updated_at": "2021-08-17T13:28:57.801578Z",
        "visibility": "public",
        "workload_minutes_late": 40.7,
        "workload_minutes_sleeping": 0,
        "workload_minutes_total": 60.7,
        "workload_minutes_working": 20
    }
}

Workflow Library Example

Edit Incident with Incidentio and Send Results Via Email

Preview this Workflow on desktop