Topic
How to use Custom Actions with Alerts.
Description
Alert Custom Actions allow an Operator to share the Alert details from Visual Command Center Operator Console to a 3rd-party service, such as an Incident or Case Management service.
Role Configuration
- Log in to the Everbridge Manager Portal and select your Organization
- Select Settings > Access > Roles
- Edit a Role
- Under VCC PERMISSIONS configure permissions for that Role as shown in the table below
| Role | Permission | Default |
| Organization Admin | Use Custom Alert Actions | ON|OFF |
| Incident Operator | Use Custom Alert Actions | ON|OFF |
| Incident Administrator | Use Custom Alert Actions | ON|OFF |
| Custom Role | Use Custom Alert Actions | ON|OFF |
Creating Custom Action
- Log in to the Everbridge Manager Portal and select your Organization
- EB 360: Workflows > CEM Orchestration > Setup > Custom Actions
- Legacy UI: Settings > Everbridge Open > CEM Orchestration > Setup > Custom Actions
- Select Add Custom Action
- Configure
- Action Name
- Action Url
- GET or POST
- Authorization
Launching Custom Action
- Access Visual Command Center (VCC)
- Click on an Alert
- Right Click on an Alert Card
- Click on Alert Widget
- Select Custom Actions
|
|
- Select the Custom Action that you want to execute
- Confirm Custom Action launch
Custom Actions and Flow Designer
Organizations can leverage Everbridge Flow Designer to exchange and synchronize data between Alert Custom Actions and the target applications in your system. Flow Designer can also automate processes and procedures that connect the different applications.
Learn more about Flow Designer here.
Example Custom Action Payload
|
Data Element |
Syntax |
Description |
|
Organization ID |
{organizationId} |
Unique ID of the Everbridge organization. |
|
Alert ID |
{alert.alertId} |
Unique ID of the Everbridge alert. |
|
Alert Expires Date Time |
{alert.expiresAt} |
Date and time the alert expires. |
|
Alert Actions |
{alertActions[]} |
Alert Action history. |
|
Last Event ID |
{lastEvent.riskEventID} |
Unique ID of the Everbridge risk event that triggered the Alert. |
|
Last Event Updated Time |
{lastEvent.updated} |
Date and time the risk event was last updated. |
|
Last Event Onset Time |
{lastEvent.Onset} |
Date and time the risk event began. |
|
Alert Closest Asset ID |
{alert.summaries[].summaryName} = closest-x-assets-only |
Comma-separated list of IDs for the 10 assets closest to the risk. |
|
Alert Closest Contact ID |
{alert.summaries[].summaryName} = closest-x-contacts-only |
Comma-separated list of IDs for the 10 contacts closest to the risk. |
|
Alert Closest Asset and Contact ID |
{alert.summaries[].summaryName} = closest-x-assets |
Comma-separated list of IDs for the 10 closest assets and contacts to the risk. |
|
Risk Event ID |
{riskEvent.identifier} |
Unique ID of the Everbridge risk event. |
|
Risk Event Sender |
{riskEvent.sender} |
Sender of the risk event information. |
|
Risk Event Source |
{riskEvent.source} |
Source of the risk event information. |
|
Risk Event Language |
(riskEvent.info.language} |
Language of the risk event information. |
|
Risk Event Categories |
{riskEvent.info.category[]} |
Comma-separated list of categories the risk event falls into. |
|
Risk Event Subcategory |
{riskEvent.info.parameter[].valueName} = subCategory |
Subcategory the risk event falls into. |
|
Risk Event Urgency |
{riskEvent.info.urgency} |
Urgency of the risk event as set in Everbridge CEM. |
|
Risk Event Severity |
{riskEvent.info.severity} |
Severity of the risk event as set in Everbridge CEM. |
|
Risk Event Significance |
{riskEvent.info.parameter[].valueName} = Significance |
Significance of the risk event as set in Everbridge CEM. |
|
Risk Event Certainty |
{riskEvent.info.certainty} |
Certainty of the risk event as set in Everbridge CEM. |
|
Risk Event Audience |
{riskEvent.info.audience} |
Audience the risk event is for. |
|
Risk Event Effective Date Time |
{riskEvent.info.effective} |
Date and time of when the source became aware of the risk information. |
|
Risk Event Onset Date Time |
{riskEvent.info.onset} |
Date and time the risk event began. |
|
Risk Event Expires Date Time |
{riskEvent.info.expires} |
Date and time the risk event expires. |
|
Risk Event Sender Name |
{riskEvent.info.senderName} |
Name of the risk event sender. |
|
Risk Event Headline |
{riskEvent.info.headline} |
Name of the risk event. |
|
Risk Event Description |
{riskEvent.info.description} |
Description of the risk event. |
|
Risk Event Instruction |
{riskEvent.info.instructions} |
Instructions to follow for the risk event. |
|
Risk Event URL |
{riskEvent.info.web} |
Unique URL for the risk event. |
|
Risk Event Contact |
{riskEvent.info.contact} |
Primary contact for the risk event. |
|
Risk Event Area Descriptions |
{riskEvent.info.area[].areaDesc} |
Description of the areas that are affected by the risk. |
Article Feedback
Please sign in to leave a comment.