v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Incidents

Create Incident

Use this API to create a new incident in the Incident Register by providing the necessary details in the request body. The response will return the unique identifier (UUID) of the newly created incident.

post/incident/v1/incidents

Request body

namestring required

Name of the incident. Provide a descriptive name to the incident so that it can be quickly referenced in the incident register.

descriptionstring

Brief description of the incident.

incidentTypeNamestring required

The name of the type of incident that has occurred.

orgGroupIdstring uuid required

Incident Organization ID. This can be retrieved from the Get List of Organizations API.

dateOccurredstring date-time

The date and time when the incident occurred, represented as an ISO 8601 timestamp in UTC.

dateDiscoveredstring date-time

The date and time when the incident was discovered, represented as an ISO 8601 timestamp in UTC.

deadlinestring date-time

The date by which the incident investigation or notification must be completed, represented as an ISO 8601 timestamp in UTC.

sourceType'MANUAL' | 'ASSESSMENT' | 'WEBFORM' | 'INTEGRATION'

rootCausestring

The root cause summary of the incident.

notificationNeeded'YES' | 'NO' | 'UNKNOWN'

attributeValuesobject

A map of custom attribute field names to the list of values associated with each attribute. Each entry in the list can contain either an 'id' (for predefined options) or a 'value', depending on the attribute configuration. If any attribute value is missing in the JSON array, the existing value for that attribute will be overridden, and the attribute will have empty values.

linkedInventoriesobject

Map of inventory types to a single inventory link request. Keys represent inventory types ('assets', 'processing-activities', 'vendors', 'entities'), and the value contains either externalIds or inventoryIds.

autoAssessJurisdictionsboolean

If set to true, automatically assess jurisdictions after incident creation.

Example request

{
  "name": "Joe sent an email to the wrong client",
  "description": "An employee accessed a restricted HR file without proper authorization.\nAccess logs confirmed the breach, and the user’s permissions were immediately revoked.\n",
  "incidentTypeName": "Misdirected Email",
  "orgGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "dateOccurred": "2019-05-31T12:43:24.173Z",
  "dateDiscovered": "2019-05-31T15:00:00.000Z",
  "deadline": "2019-07-31T12:43:24.173Z",
  "sourceType": "INTEGRATION",
  "rootCause": "The root cause was traced to a lack of validation in the email recipient auto-fill feature,\nleading to sensitive data being sent to the wrong external recipient.\n",
  "notificationNeeded": "YES",
  "attributeValues": {
    "customTextAttributeFieldName": [
      {
        "value": "Attribute Value"
      }
    ],
    "customSingleSelectAttributeFieldName": [
      {
        "value": "Option Value 1"
      }
    ],
    "customMultiSelectAttributeFieldName": [
      {
        "value": "Option Value 2"
      },
      {
        "value": "Option Value 3"
      }
    ]
  },
  "incidentAssigneeRequests": [
    {
      "assigneeId": "550e8400-e29b-41d4-a716-446655440000",
      "assigneeEmail": "user@example.com",
      "type": "USER"
    }
  ],
  "jurisdictions": [
    {
      "jurisdictionId": "123e4567-e89b-12d3-a456-426614174000",
      "stateProvinceCode": "CA"
    }
  ],
  "linkedInventories": {
    "assets": {
      "externalIds": [
        "Asset External ID"
      ]
    },
    "processing-activities": {
      "externalIds": [
        "Processing Activity External ID"
      ]
    },
    "vendors": {
      "externalIds": [
        "Vendor External ID"
      ]
    },
    "entities": {
      "externalIds": [
        "Legal Entity External ID"
      ]
    }
  }
}

Response

Incident created successfully. The response contains the UUID of the newly created incident.

string uuid required

Example response

"f7114aef-b6b6-42d6-9249-56a467950aa7"