Everbridge
App Vendor: Everbridge
App Category: Network Security, IT Services
Connector Version: 1.0.0
API Version: 3.0
Notice
This is a beta-app and the documentation is in progress.
About App
Everbridge is an enterprise software company that offers applications which provide information about critical events to help with personal safety and business continuity.
The Everbridge app is configured with Orchestrate to perform the following actions:
Action Name | Description |
---|---|
Change Incident Status | This action updates the status of an incident. |
Get Asset Details | This action retrieves the details of an asset. |
Get Assets | This action retrieves the assets of an organization. |
Get Calendar | This action retrieves the calendars based on the calendar IDs. |
Get Incident Details | This action retrieves the details of an incident. |
Get Incidents | This action retrieves the incidents of an organization. |
Get Journals for Incident | This action retrieves journals for an incident. |
Get Notification | This action retrieves the status of a notification. |
Get Notifications For Incident | This action retrieves the notifications of an incident. |
Initiate Notification | This action initiates a notification to a contact or contact group. |
Launch Crisis Event | This action launches a crisis event. |
List Active Calendars | This action lists the active calendars of an organization. |
List Audit Logs | This action retrieves a list of audit logs. |
List Calendars | This action lists the calendars of an organization. |
List Crisis Events | This action retrieves a list of crisis events. |
List Notifications | This action retrieves the notifications of an organization. |
List Staff for Calendar | This action lists the staff of an organization for a calendar period. |
Update Asset Details | This action updates the details of an asset. |
Update Crisis Event | This action updates a crisis event. |
Update Incident | This action updates or closes an incident. |
Update Notification | This action updates a notification. |
Configuration Parameters
The following configuration parameters are required for the Everbridge app to communicate with the Everbridge enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Access Key ID | Enter the access key ID provided by Everbridge. | Text | Required | |
Secret Access Key | Enter the secret access key provided by Everbridge. | Text | Required | |
Organization ID | Enter the Everbridge ID of your organization. | Text | Required | |
SSL Verification | Choose to verify SSL certificates. Example: false | Boolean | Optional | Default value: true Allowed values:
|
Action: Change Incident Status
This action updates the status of an incident.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Incident ID | Enter the incident ID. | Integer | Required | You can retrieve an incident ID using Action: Get Incidents. |
Status | Enter the status of the incident. | Text | Required | Allowed values:
|
Action: Get Asset Details
This action retrieves the details of an asset.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
ID | Enter the asset ID or external ID of an asset to retrieve its details. | Text | Required | You can retrieve an asset ID using Action: Get Assets. |
ID Type | Enter the ID type. | Text | Optional | Default value: id Allowed values:
|
Action: Get Assets
This action retrieves assets of a organization.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Page | Enter the total number of pages of results to retrieve. | Integer | Optional | Default value: 1 |
Action: Get Calendar
This action retrieves the calendars based on the calendar IDs.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Calendar ID | Enter the comma-separated list of calendar IDs. | Text | Required | You can retrieve a calendar ID using Action: List Calendars. |
Action: Get Incident Details
This action retrieves details of an incident.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Incident ID | Enter an incident ID to retrieve details of an incident. | Integer | Required | You can retrieve an incident ID using Action: Get Incidents. |
Action: Get Incidents
This action retrieves incidents of an organization.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Only Open | Choose to return only open incidents. | Boolean | Optional | Default value: false Allowed values:
|
Page | Enter the total number of pages of results to display. | Integer | Optional | Default value: 1 |
Page Size | Enter the number of incidents to be displayed per page. | Integer | Optional | Default value: 10 |
Status | Enter the incident status to retrieve incidents | Text | Optional | Default value: all Allowed values:
|
Incident Type | Enter the incident type. | Text | Optional | Default value: incident Allowed values:
|
Start Time | Enter the start time from which results will be returned. | Text | Optional | |
End Time | Enter the end time till which results will be returned. | Text | Optional | |
Date Type | Enter the date type to use for Start Time parameter and End Time parameter. | Text | Optional | Default value: createddate Allowed values:
|
Action: Get Journals for Incident
This action retrieves journals of an incident.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Incident ID | Enter the incident ID to retrieve the journals of an incident. | Integer | Required | You can retrieve an incident ID using Action: Get Incidents. |
Action: Get Notification
This action retrieves the status of a notification.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Notification ID | Enter the notification ID to retrieve the status of a notification. | Integer | Required | You can retrieve a notification ID using Action: Get Notifications. |
Verbose | Choose to return detailed results. | Boolean | Optional | Default value: false Allowed values:
|
Action: Get Notifications For Incident
This action retrieves notifications of an incident.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Incident ID | Enter the incident ID to retrieve notifications. | Integer | Required | You can retrieve an incident ID using Action: Get Incidents. |
Page | Enter the total number of pages of results to retrieve. | Integer | Optional | Default value: 1 |
Action: Initiate Notification
This action initiates an immediate notification to be sent to the specified contacts.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Title | Enter the title of notification. | Text | Required | |
Message | Enter the message of notification. | Text | Required | |
Contact IDs | Enter a list of external IDs to send a notification. | List | Optional | You can retrieve a Contact ID using Action: List Staff for Calendar. |
Contact Group IDs | Enter a list of contact group IDs to send a notification. | List | Optional | You can retrieve a Contact Group ID using Action: List Staff for Calendar. |
Priority | Choose to mark the message as a priority. | Boolean | Optional | Default value: false Allowed values:
|
Action: Launch Crisis Event
This action launches a crisis event.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Crisis Event | Enter a crisis event that you need to launch. | Key Value | Required |
Action: List Active Calendars
This action lists the active calendars of an organization.
Action Input Parameters
This action does not require any action input parameters.
Action: List Audit Logs
This action retrieves a list of crisis event audit logs.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Crisis Event ID | Enter the crisis event ID. | Text | Required | You can retrieve a crisis event ID using Action: List Crisis Events. |
Order Direction | Enter the sorting order to sort the audit logs. | Text | Optional | Default values: desc Allowed values:
|
Page | Enter the total number of pages of results to retrieve. | Integer | Optional | Default value: 1 |
Page Size | Enter the number of results to be displayed per page. | Integer | Optional | Default value: 25 |
Action: List Calendars
This action lists calendars of an organization
Action Input Parameters
This action does not require any action input parameters.
Action: List Crisis Events
This action retrieves a list of crisis events.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Event Status | Enter the status of crisis events that you need to retrieve. | Text | Optional | Default value: active Allowed values:
|
Sort Column | Enter the column by which you need to sort the crisis events. | Text | Optional | Default value: createddate Allowed values:
|
Order Direction | Enter the sorting order to list crisis events. | Text | Optional | Default value: desc Allowed values:
|
Page | Enter the total number of pages of results to retrieve. | Integer | Optional | Default value: 1 |
Page Size | Enter the total number of results to be displayed per page. | Integer | Optional | Default value: 25 |
Action: List Notifications
This action retrieves notifications of an organization.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Event ID | Enter the event ID to retrieve notifications for a specific event. | Integer | Optional | You can retrieve an event ID using Action: List Crisis Events. |
Only Active | Choose to retrieve only active notifications. | Boolean | Optional | Default value: false Allowed values:
|
Page | Enter the total number of pages of results to retrieve. | Integer | Optional | Default value: 1 |
Action: List Staff for Calendar
This action lists the staff of an organization for a calendar period.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Calendar ID | Enter the external ID of a calendar. | Text | Required | You can retrieve a calendar ID using Action: List Calendars. |
Shift Name | Enter the name of the shift for which you need to list staff. | Text | Optional | |
From Date | Enter the from date to list staff. | Text | Optional | |
To Date | End the to date to list staff. | Text | Optional |
Action: Update Asset Details
The action updates the details of an asset.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
ID | Enter the asset ID or external ID. | Text | Required | You can retrieve an asset ID using Action: Get Assets. |
Asset | Enter the data to update an asset. | Key Value | Required | |
Auto Geo Coding | Choose to automatically geocode an asset. | Boolean | Optional | Default value: false Allowed values:
|
Action: Update Crisis Event
This action updates a crisis event.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Event ID | Enter the ID of a crisis event that you need to update. | Text | Required | You can retrieve an event ID using Action: List Crisis Events. |
Crisis Event | Enter the data to update a crisis event. | Key Value | Required |
Action: Update Incident
This action updates or closes an incident.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Incident ID | Enter the ID of an incident that you need to update. | Integer | Required | You can retrieve an incident ID using Action: Get Incidents. |
Incident | Enter the data to update an incident. | Key Value | Required |
Action: Update Notification
This action updates a notification.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Notification ID | Enter the ID of notification that you need to update. | Integer | Required | You can retrieve a notification ID using Action: Get Notifications. |
Notification | Enter the data to update a notification. | Key Value | Required |