v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Incidents

Import an incident

Import an incident from an external system. This endpoint allows you to create incidents with historical data such as custom timestamps for detection, declaration, and resolution. Imported incidents do not execute integrations or notification rules.

post/api/v2/incidents/import

Query parameters

includeIncidentImportRelatedObject[]

Specifies which related object types to include in the response when importing an incident.

Request body

Example request

{
  "data": {
    "attributes": {
      "declared": "2025-01-01T00:00:00Z",
      "detected": "2025-01-01T00:00:00Z",
      "fields": {
        "severity": {
          "value": "SEV-5"
        },
        "state": {
          "value": "active"
        }
      },
      "incident_type_uuid": "00000000-0000-0000-0000-000000000000",
      "resolved": "2025-01-01T01:00:00Z",
      "title": "Imported incident from external system",
      "visibility": "organization"
    },
    "relationships": {
      "commander_user": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "users"
        }
      },
      "declared_by_user": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "users"
        }
      }
    },
    "type": "incidents"
  }
}

Response

CREATED

Example response

{
  "data": {
    "attributes": {
      "created": "2025-01-01T00:00:00Z",
      "customer_impact_scope": "An example customer impact scope",
      "declared": "2025-01-01T00:00:00Z",
      "detected": "2025-01-01T00:00:00Z",
      "fields": {
        "severity": {
          "type": "dropdown",
          "value": "SEV-5"
        }
      },
      "incident_type_uuid": "00000000-0000-0000-0000-000000000000",
      "notification_handles": [
        {
          "display_name": "Jane Doe",
          "handle": "@test.user@test.com"
        }
      ],
      "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"
          }
        ]
      },
      "incident_type": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "incident_types"
        }
      },
      "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"
    }
  ]
}