Incidents Create

POST

Creates an incident.

Request

This endpoint expects an object.
titlestringRequired

Title of the incident.

acknowledged_datedatetimeOptional

Timestamp when the incident was acknowledged.

applies_to_partslist of stringsOptional

Parts to which the incident is applicable to.

artifactslist of stringsOptional

Artifacts attached to the incident.

bodystringOptional

Body of the incident.

custom_fieldsmap from strings to anyOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Requested custom schemas described abstractly. Every provided schema’s custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

identified_datedatetimeOptional

Time when the incident was identified/reported.

impactobjectOptional
impacted_customerslist of stringsOptional

List of customers impacted due to the incident.

mitigated_datedatetimeOptional

Timestamp when the incident was mitigated.

owned_bylist of stringsOptional

User IDs of the users that own the incident.

pialist of stringsOptional

The article ids of the Post-Incident Analysis(PIA) of the incident.

playbookslist of stringsOptional

The article ids of the playbook(s) associated with the incident.

related_docslist of stringsOptional

The article ids of other documents associated with the incident.

reported_bylongOptional

The entity that first reported the incident.

severitylongOptional

Severity of the incident.

sourcelongOptional

Source of where the incident was created. Only sys users and service accounts are supposed to set this field.

stageobjectOptional

Create object for stage.

stakeholderslist of stringsOptional

Users, along with the incident commander, involved in resolving incidents and handling communication.

tagslist of objectsOptional

Tags associated with the object.

target_close_datedatetimeOptional

Timestamp when the incident is expected to be resolved.

Response

This endpoint returns an object.
incidentobject