v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Incidents

Create an incident

Create an incident.

post/api/v2/incidents

Request body

Example request

{
  "data": {
    "attributes": {
      "customer_impact_scope": "Example customer impact scope",
      "fields": {
        "severity": {
          "type": "dropdown",
          "value": "SEV-5"
        }
      },
      "incident_type_uuid": "00000000-0000-0000-0000-000000000000",
      "initial_cells": [
        {
          "cell_type": "markdown",
          "content": {
            "content": "An example timeline cell message."
          }
        }
      ],
      "notification_handles": [
        {
          "display_name": "Jane Doe",
          "handle": "@user@email.com"
        },
        {
          "display_name": "Slack Channel",
          "handle": "@slack-channel"
        },
        {
          "display_name": "Incident Workflow",
          "handle": "@workflow-from-incident"
        }
      ],
      "title": "A test incident title"
    },
    "relationships": {
      "commander_user": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "users"
        }
      }
    },
    "type": "incidents"
  }
}

Response

CREATED

Example response

{
  "data": {
    "attributes": {
      "customer_impact_scope": "An example customer impact scope",
      "fields": {
        "severity": {
          "type": "dropdown",
          "value": "SEV-5"
        }
      },
      "incident_type_uuid": "00000000-0000-0000-0000-000000000000",
      "notification_handles": [
        {
          "display_name": "Jane Doe",
          "handle": "@user@email.com"
        },
        {
          "display_name": "Slack Channel",
          "handle": "@slack-channel"
        },
        {
          "display_name": "Incident Workflow",
          "handle": "@workflow-from-incident"
        }
      ],
      "public_id": 1,
      "severity": "UNKNOWN",
      "title": "A test incident title"
    },
    "id": "00000000-0000-0000-1234-000000000000",
    "relationships": {
      "attachments": {
        "data": [
          {
            "id": "00000000-0000-abcd-1000-000000000000",
            "type": "incident_attachments"
          }
        ]
      },
      "commander_user": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "users"
        }
      },
      "created_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      },
      "declared_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      },
      "impacts": {
        "data": [
          {
            "id": "00000000-0000-0000-2345-000000000000",
            "type": "incident_impacts"
          }
        ]
      },
      "integrations": {
        "data": [
          {
            "id": "00000000-abcd-0005-0000-000000000000",
            "type": "incident_integrations"
          },
          {
            "id": "00000000-abcd-0006-0000-000000000000",
            "type": "incident_integrations"
          }
        ]
      },
      "last_modified_by_user": {
        "data": {
          "id": "00000000-0000-0000-2345-000000000000",
          "type": "users"
        }
      },
      "responders": {
        "data": [
          {
            "id": "00000000-0000-0000-2345-000000000000",
            "type": "incident_responders"
          }
        ]
      },
      "user_defined_fields": {
        "data": [
          {
            "id": "00000000-0000-0000-2345-000000000000",
            "type": "user_defined_field"
          }
        ]
      }
    },
    "type": "incidents"
  },
  "included": [
    {
      "type": "users"
    }
  ]
}