get https://api.everbridge.net/rest/incidents//
Retrieve details of an incident within an organization. This also returns the list of notifications launched within a given incident.
Response body
Tips
For every notification launched for an incident, there will be an entry within result.incidentPhases with a unique notificationId
Property | Description |
---|---|
id | Incident ID. |
name | Name of the incident. Note that this is NOT the template name |
incidentStatus | Open or Closed. |
incidentType | Incident or Scenario. |
incidentPhases.notificationId | Notification Id launched using this template phase. |
incidentPhases.status | This will always be 'A' |
incidentPhases.name | System defined phase name (New/Updated/Closed) |
incidentPhases.id | - 10011: Indicates 'New' phase. - 20011: Indicates 'Updated' phase. For multiple updates, this number will be sequentially updated. - 30011: Indicates 'Closed' phase |
incidentPhases.phaseTemplate.name | Custom phase name provided in manager portal for the phase used for this notification. |
incidentPhases.phaseDefinition.id | - 1001: New phase - 1002: Updated phase - 1003: Closed phase |
phaseStatus | Phase detail for the phase used in the most recent notification |