Everbridge Incidents API

openapi: 3.2.0
info:
  title: Everbridge Incidents API
  version: '1.0'
  description: 'Operations tagged Incidents across 2 of this provider''s published API definitions: everbridge-digital-apps-openapi.json, everbridge-eb-suite-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.everbridge.net/digitalapps/v2
- url: https://api.everbridge.net/rest
- url: https://api.everbridge.eu/rest
tags:
- name: Incidents
  description: Incidents operations
paths:
  /incidents/{incidentId}:
    get:
      tags:
      - Incidents
      summary: Get Incident
      description: Retrieve the incident by incident id
      operationId: ebs-daa-get-incident
      parameters:
      - name: incidentId
        in: path
        description: Incident id
        required: true
        schema:
          type: integer
          format: int64
        example: 1539455328453094
      - name: Client-Id
        in: header
        description: Custom app client id
        required: true
        schema:
          type: string
        example: 3efb35a2-fdee-44bb-b476-2a45cada8b00
      - name: Authorization
        in: header
        description: Access token
        required: true
        schema:
          type: string
        example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLXRlc3QiLCJyb2xlIjoiYWRtaW4iLCJpYXQiOjE3MDAwMDAwMDAsImV4cCI6MjAwMDAwMDAwMH0.MEUCIQDRrT_U-WXmq9sdlqZQw4y1GiI4Pp2tJSrKzWSi8vBslgIgQzRSce6h7RkF70ZcQnFX6Zry8FSX8U5CggV2-3OyuVE
      responses:
        '200':
          description: Retrieve the incident by incident id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentV2response'
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        httpMethod: get
        uri: https://mobilemember.everbridge.net/api/v2/incidents/{incidentId}
        requestParameters:
          integration.request.path.incidentId: method.request.path.incidentId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        passthroughBehavior: when_no_match
    servers:
    - url: https://api.everbridge.net/digitalapps/v2
  /incidentJournals/{organizationId}/{incidentId}:
    get:
      description: Get all incident journals for a given incidentId
      operationId: EBS Get Journals
      parameters:
      - example: '591470146880572'
        in: path
        name: incidentId
        required: true
        schema:
          maxLength: 16
          type: string
      - in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  summary: Success
                  value:
                    firstPageUri: https://api-dev3.everbridge.net/rest/incidentJournals/1536984111644674/633389027691687/?pageNumber=1
                    lastPageUri: https://api-dev3.everbridge.net/rest/incidentJournals/1536984111644674/633389027691687/?pageNumber=0
                    message: OK
                    nextPageUri: https://api-dev3.everbridge.net/rest/incidentJournals/1536984111644674/633389027691687/?pageNumber=2
                    page:
                      currentPageNo: 1
                      data:
                      - accountId: 1536846672691202
                        createdDate: 1678041125595
                        createdId: 1530249602924607
                        createdName: Vishal Agrawal
                        id: 0
                        incidentId: 633389027691687
                        journalEntry: 'Launch incident:  with Response Subscription: Profile Id: 63f9025e74afd050981becae, Response type: EVERY, Polling response: .'
                        lastModifiedDate: 1678041125595
                        lastModifiedId: 1530249602924607
                        lastModifiedName: Vishal Agrawal
                        organizationId: 1536984111644674
                        resourceBundleId: 1536984111644675
                        status: A
                      - accountId: 1536846672691202
                        createdDate: 1679429073965
                        createdId: 1536846672691205
                        createdName: Ajay Goel
                        id: 0
                        incidentId: 633389027691687
                        journalEntry: Added via API
                        lastModifiedDate: 1679429073965
                        lastModifiedId: 1536846672691205
                        lastModifiedName: Ajay Goel
                        organizationId: 1536984111644674
                        resourceBundleId: 1536984111644675
                        status: A
                      pageSize: 10
                      start: 0
                      totalCount: 0
                      totalPageCount: 0
              schema: {}
          description: OK
      security:
      - API_Authorizer: []
      - BasicAuth: []
      - api_key: []
      summary: Get Journals
      tags:
      - Incidents
      x-amazon-apigateway-integration:
        httpMethod: GET
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.incidentId: method.request.path.incidentId
          integration.request.path.organizationId: method.request.path.organizationId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/incidentJournals/{organizationId}/{incidentId}
    post:
      description: Add a new incident journal to a given incident
      operationId: EBS Add Incident Journal
      parameters:
      - example: '591470146880572'
        in: path
        name: incidentId
        required: true
        schema:
          maxLength: 16
          type: string
      - in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      requestBody:
        content:
          application/json:
            examples:
              Default:
                summary: Add journal to incident
                value:
                  journalEntry: Follow up needed on this incident
            schema:
              properties:
                journalEntry:
                  description: Journal entry to be added
                  maxLength: 500
                  type: string
              required:
              - journalEntry
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  summary: Journal entry added
                  value:
                    baseUri: https://api-dev3.everbridge.net/rest/incidentJournals/1536984111644674/
                    id: 591470146880572
                    instanceUri: https://api-dev3.everbridge.net/rest/incidentJournals/1536984111644674/591470146880572
                    message: OK
              schema: {}
          description: OK
      security:
      - API_Authorizer: []
      - BasicAuth: []
      - api_key: []
      summary: Add Incident Journal
      tags:
      - Incidents
      x-amazon-apigateway-integration:
        httpMethod: POST
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.incidentId: method.request.path.incidentId
          integration.request.path.organizationId: method.request.path.organizationId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/incidentJournals/{organizationId}/{incidentId}
    servers:
    - url: https://api.everbridge.net/rest
    - url: https://api.everbridge.eu/rest
  /incidents/{organizationId}:
    get:
      description: 'Retrieve all the incidents for an organization. '
      operationId: EBS List Incidents
      parameters:
      - in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      - description: Boolean value indicating whether only open incidents should be returned.
        in: query
        name: onlyOpen
        required: false
        schema:
          default: false
          type: boolean
      - description: The page number of incidents to return.
        in: query
        name: pageNumber
        required: false
        schema:
          default: 1
          format: int32
          type: integer
      - description: The page size of incidents to return.
        in: query
        name: pageSize
        required: false
        schema:
          default: 10
          format: int32
          type: integer
      - description: Return incidents by specified status.
        in: query
        name: status
        required: false
        schema:
          default: All
          enum:
          - All
          - Open
          - Closed
          type: string
      - description: Return incidents by specified type.
        in: query
        name: incidentType
        required: false
        schema:
          default: Incident
          enum:
          - Incident
          - Scenario
          - All
          type: string
      - description: Business module type.
        in: query
        name: businessModuleType
        required: false
        schema:
          enum:
          - AlertEvent
          type: string
      - description: Start time of createdDate/lastModifiedDate/closeDate (epoch format).
        example: 1720542948557
        in: query
        name: startTime
        required: false
        schema:
          format: int64
          type: integer
      - description: End time of createdDate/lastModifiedDate/closeDate (epoch format).
        example: 1718267242885
        in: query
        name: endTime
        required: false
        schema:
          format: int64
          type: integer
      - description: dateType will be used with time range of startTime or endTime.
        in: query
        name: dateType
        required: false
        schema:
          default: createdDate
          enum:
          - createdDate
          - lastModifiedDate
          - lastModifiedDateAny
          - closedDate
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  summary: Default
                  value:
                    message: OK
                    result:
                      accountId: 453003085614350
                      closeBy: Ajay Goel
                      closeDate: 1658191464719
                      createdDate: 1658191408215
                      createdId: 505642204790883
                      createdName: Ajay Goel
                      duration: 56
                      enableMessageTruncate: false
                      hasJournal: false
                      id: 3017751396588101
                      incidentAction: Launch
                      incidentPhases:
                      - accountId: 453003085614350
                        createdDate: 1658191408222
                        createdId: 505642204790883
                        createdName: Ajay Goel
                        id: 10011
                        incidentId: 3017751396588101
                        lastModifiedDate: 1658191408222
                        lastModifiedId: 505642204790883
                        lastModifiedName: Ajay Goel
                        name: New
                        notificationId: 3017751396440312
                        organizationId: 892807736728255
                        phaseDefinition:
                          id: 1001
                          incidentStatus: Open
                          isDefault: true
                          name: New
                          phaseNodeType: Begin
                          seq: 100
                          status: A
                        phaseTemplate:
                          contactsFlag: 3
                          evaluateAll: false
                          formTemplate:
                            formVariableItems:
                            - isRequired: false
                              seq: 1
                              variableId: 8110002061444228
                              variableName: Priority
                            - isRequired: false
                              seq: 2
                              variableId: 8110002061444229
                              variableName: Summary
                            - isRequired: false
                              seq: 3
                              val:
                              - Accounting & Finance
                              variableId: 8110002061447337
                              variableName: Business Unit
                            preMessage: "Priority: \nSummary:"
                            subject: 'API  Doc Testing- '
                            sysVarCurrentTimeFormat: HH:mm:ss
                            sysVarTodayDateFormat: mm-dd-yyyy
                          ignoreVariable: true
                          incidentNotificationPropertyBag:
                            enableExerciseMode: 'false'
                          messageFlag: 3
                          name: Created
                          publishOptionsFlag:
                            abb: 1
                            alertUs: 1
                            desktopAlerts: 1
                            ipawsCap: 1
                            memberPortal: 1
                            network: 1
                            nixleChannel: 1
                            socialMedia: 1
                            webPosting: 1
                            webWidget: 0
                          settingsFlag: 3
                          templateId: 1536984111644674
                          templateName: 1 - Readme API doc testing
                        resourceBundleId: 453003085618621
                        status: A
                      - comment: Removed additional repeating nodes for brevity.
                      incidentStatus: Closed
                      incidentType: Incident
                      lastModifiedDate: 1658191464719
                      lastModifiedDateAny: 1658191464719
                      lastModifiedId: 505642204790883
                      lastModifiedName: Ajay Goel
                      name: API  Doc Testing-
                      organizationId: 892807736728255
                      phaseStatus:
                        id: 1003
                        incidentStatus: Closed
                        isDefault: false
                        name: Close
                        phaseNodeType: End
                        seq: 300
                        status: A
                      resourceBundleId: 453003085618621
                      status: A
                      useTemplateVarValue: false
              schema:
                $ref: '#/components/schemas/IncidentResponse'
          description: Accepted
        '404':
          content:
            application/json:
              examples:
                Not found:
                  summary: Incident not found
                  value:
                    message: Incident 301678932871606 not found
                    status: 404
              schema:
                properties:
                  message:
                    description: Error message
                    enum:
                    - Incident <incidentId> not found
                    type: string
                  status:
                    description: Request status
                    enum:
                    - '404'
                    type: string
                type: object
          description: Incident Not Found
      security:
      - API_Authorizer: []
      - BasicAuth: []
      - api_key: []
      summary: List Incidents
      tags:
      - Incidents
      x-amazon-apigateway-integration:
        httpMethod: GET
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/incidents/{organizationId}
    post:
      description: Creating a new incident results in launching one or more new notifications.  Incident can be launched with default values set up at the template level or various parameters defined at the template level can be overridden by sending it through this API.
      operationId: EBS Launch Incident
      parameters:
      - in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      requestBody:
        content:
          application/json:
            examples:
              Default:
                summary: Default Template Values
                value:
                  incidentAction: Launch
                  incidentPhases:
                  - phaseTemplate:
                      templateId: 1536984111644674
              Override Delivery Path/Sender Info/Duration:
                summary: Override Delivery Paths, Sender Information and maximize duration
                value:
                  incidentAction: Launch
                  incidentPhases:
                  - phaseTemplate:
                      broadcastTemplate:
                        broadcastSettings:
                          deliverPaths:
                          - id: 8105604014932722
                          duration: 5
                          durationTimeUnit: DAYS
                          senderCallerInfos:
                          - callerId: '+17817817811'
                            countryCode: US
                            countryName: United States
                          senderEmail: API Notification
                      templateId: '1536984111644674'
              Override Recipients:
                summary: Override Recipients and Variables
                value:
                  incidentAction: LaunchThenClose
                  incidentPhases:
                  - phaseTemplate:
                      broadcastTemplate:
                        broadcastContacts:
                          externalIds:
                          - apidocextuser
                          groupIds:
                          - '3008835044245508'
                      formTemplate:
                        formVariableItems:
                        - val:
                          - This incident will auto close after launch
                          variableId: 8110002061444229
                      templateId: 1536984111644674
              Override TemplateId and VariableId:
                summary: Override TemplateId and VariableId
                value:
                  incidentAction: Launch
                  incidentPhases:
                  - phaseTemplate:
                      formTemplate:
                        formVariableItems:
                        - val:
                          - High
                          variableId: 589820879437825
                      templateId: 593978407780353
              Subject and Variables:
                summary: Override Notification Title and Variables
                value:
                  incidentAction: Launch
                  incidentPhases:
                  - phaseTemplate:
                      formTemplate:
                        formVariableItems:
                        - val:
                          - High
                          variableId: 8110002061444228
                        - val:
                          - Variable summary has been replaced with text from API
                          variableId: 8110002061444229
                        - val:
                          - Accounting & Finance
                          - Call Centers
                          variableId: 8110002061447337
                        postMessage: This is the closing instructions in the message sent out.
                        preMessage: This is sent as SMS Text, Fax, Pager, Text-to-speech conversation.
                        subject: Subject of the message sent out.  This is also the incident name and notification title
                      templateId: 1536984111644674
            schema:
              $ref: '#/components/schemas/createIncident'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                Default:
                  summary: Created
                  value:
                    baseUri: https://api-dev3.everbridge.net/rest/incidents/892807736728255/
                    id: 3004419817920365
                    instanceUri: https://api-dev3.everbridge.net/rest/incidents/892807736728255/3004419817920365
                    message: OK
              schema:
                properties:
                  baseUri:
                    description: API endpoint base URL.  You must append incidentId to retrieve the incident.
                    type: string
                  id:
                    description: Incident ID of the created incident.
                    type: string
                  instanceUri:
                    description: API endpoint which can be used to return the incident details.
                    type: string
                  message:
                    description: Returns status (OK).
                    type: string
                type: object
          description: Created
        '400':
          content:
            application/json:
              examples:
                Default:
                  summary: Validation Error
                  value:
                    message: Invalid template id.
                    status: 400
              schema:
                properties:
                  message:
                    description: Error message
                    enum:
                    - Information variable <variableName>[variableID] is required!
                    - Invalid template id
                    type: string
                  status:
                    description: "Request Status\n * 400: Validation Error\n * 500: Unexpected Error"
                    type: string
                type: object
          description: Bad Request
      security:
      - API_Authorizer: []
      - BasicAuth: []
      - api_key: []
      summary: Launch Incident
      tags:
      - Incidents
      x-amazon-apigateway-integration:
        httpMethod: POST
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/incidents/{organizationId}
    servers:
    - url: https://api.everbridge.net/rest
    - url: https://api.everbridge.eu/rest
  /incidents/{organizationId}/incidentDynamicInfo/query:
    post:
      description: Get dynamic information after parsing
      operationId: EBS Get Incident Dynamic Info Query
      parameters:
      - in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      requestBody:
        content:
          application/json:
            schema: {}
        required: true
      responses:
        '200':
          content:
            application/json:
              examples: {}
              schema: {}
          description: Created
        '400':
          content:
            application/json:
              examples: {}
              schema:
                properties:
                  message:
                    description: Error message
                    enum:
                    - Missing or invalid request input
                    type: string
                  status:
                    description: Missing or invalid request input
                    type: string
                type: object
          description: Missing or invalid request input
      security:
      - API_Authorizer: []
      - BasicAuth: []
      - api_key: []
      summary: Get Incident Dynamic Info Query
      tags:
      - Incidents
      x-amazon-apigateway-integration:
        httpMethod: POST
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/incidents/{organizationId}/incidentDynamicInfo/query
    servers:
    - url: https://api.everbridge.net/rest
    - url: https://api.everbridge.eu/rest
  /incidents/{organizationId}/preview:
    post:
      description: Returns a dummy incident.
      operationId: EBS Preview Incident
      parameters:
      - in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      requestBody:
        content:
          application/json:
            examples:
              Default:
                summary: Default Template Values
                value:
                  incidentAction: Launch
                  incidentPhases:
                  - phaseTemplate:
                      templateId: 1536984111644674
            schema:
              $ref: '#/components/schemas/previewIncident'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                Default:
                  summary: Created
                  value:
                    baseUri: https://api-dev3.everbridge.net/rest/incidents/892807736728255/
                    id: 3004419817920365
                    instanceUri: https://api-dev3.everbridge.net/rest/incidents/892807736728255/3004419817920365
                    message: OK
              schema:
                properties:
                  baseUri:
                    description: API endpoint base URL.  You must append incidentId to retrieve the incident.
                    type: string
                  id:
                    description: Incident ID of the created incident.
                    type: string
                  instanceUri:
                    description: API endpoint which can be used to return the incident details.
                    type: string
                  message:
                    description: Returns status (OK).
                    type: string
                type: object
          description: Created
        '400':
          content:
            application/json:
              examples:
                Default:
                  summary: Validation Error
                  value:
                    message: Invalid template id.
                    status: 400
              schema:
                properties:
                  message:
                    description: Error message
                    enum:
                    - Information variable <variableName>[variableID] is required!
                    - Invalid template id
                    type: string
                  status:
                    description: "Request Status\n * 400: Validation Error\n * 500: Unexpected Error"
                    type: string
                type: object
          description: Bad Request
      security:
      - API_Authorizer: []
      - BasicAuth: []
      - api_key: []
      summary: Preview Incident
      tags:
      - Incidents
      x-amazon-apigateway-integration:
        httpMethod: POST
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/incidents/{organizationId}/preview
    servers:
    - url: https://api.everbridge.net/rest
    - url: https://api.everbridge.eu/rest
  /incidents/{organizationId}/verifyPIN:
    post:
      description: The organization from which to verify the PIN
      operationId: EBS Incident Verify Pin
      parameters:
      - in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      requestBody:
        content:
          application/json:
            schema: {}
        required: true
      responses:
        '200':
          content:
            application/json:
              examples: {}
              schema: {}
          description: Created
        '400':
          content:
            application/json:
              examples: {}
              schema:
                properties:
                  message:
                    description: Error message
                    enum:
                    - Missing or invalid request input
                    type: string
                  status:
                    description: Missing or invalid request input
                    type: string
                type: object
          description: Missing or invalid request input
      security:
      - API_Authorizer: []
      - BasicAuth: []
      - api_key: []
      summary: Incident Verify Pin
      tags:
      - Incidents
      x-amazon-apigateway-integration:
        httpMethod: POST
        passthroughBehavior: when_no_match
        requestParameters:
          integration.request.path.organizationId: method.request.path.organizationId
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https://ebs-restapi-prod-us.evbg.io/rest/incidents/{organizationId}/verifyPIN
    servers:
    - url: https://api.everbridge.net/rest
    - url: https://api.everbridge.eu/rest
  /incidents/{organizationId}/{incidentId}:
    get:
      description: 'Retrieve details of an incident within an organization.  This also returns the list of notifications launched within a given incident. '
      operationId: EBS Get Incident
      parameters:
      - example: '591470146880507'
        in: path
        name: incidentId
        required: true
        schema:
          maxLength: 16
          type: string
      - in: path
        name: organizationId
        required: true
        schema:
          $ref: '#/components/schemas/organizationId'
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  summary: Default
                  value:
                    message: OK
                    result:
                      accountId: 453003085614350
                      closeBy: Ajay Goel
                      closeDate: 1658191464719
                      createdDate: 1658191408215
                      createdId: 505642204790883
                      createdName: Ajay Goel
                      duration: 56
                      enableMessageTruncate: false
                      hasJournal: false
                      id: 3017751396588101
                      incidentAction: Launch
                      incidentPhases:
                      - accountId: 453003085614350
                        createdDate: 1658191408222
                        createdId: 505642204790883
                        createdName: Ajay Goel
                        id: 10011
                        incidentId: 3017751396588101
                        lastModifiedDate: 1658191408222
                        lastModifiedId: 505642204790883
                        lastModifiedName: Ajay Goel
                        name: New
                        notificationId: 3017751396440312
                        organizationId: 892807736728255
                        phaseDefinition:
                          id: 1001
                          incidentStatus: Open
                          isDefault: true
                          name: New
                          phaseNodeType: Begin
                          seq: 100
                          status: A
                        phaseTemplate:
                          contactsFlag: 3
                          evaluateAll: false
                          formTemplate:
                            formVariableI

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/everbridge/refs/heads/main/openapi/everbridge-incidents-api-openapi.yml