Early Access
Events module is not enabled for all users. If you’d like to try it out, please email our support team for early access. In either scenario, whether your bridge is successfully connected and operational, or experiencing unforeseen disruptions impacting regular operations, it is essential to stay well-informed and respond promptly. The Events module in Bridge plays a vital role in assisting you during such times.
The Events module helps you watch specific occurrences, allowing you to take necessary actions when they occur, ensuring smooth operations. Some situations are already defined as events, and you can configure alerts and webhooks for prompt actions. A configured event oversees all the bridges within the Qntrl account, triggering pre-defined actions when the event occurs for any of the bridges.
For example, for an event like Bridge Down, you can configure an email alert. When a downtime event happens, email alerts are sent to the designated point of contacts (PoCs) or directly responsible individuals (DRIs), prompting them to take necessary actions.
Events are optional and additional configuration, that is, if no events are configured, the bridge will continue to operate as expected without any changes to its functionality.
There are four predefined events available, and they work based on user configurations. Events cannot be deleted, they can only be activated or deactivated. Each event can be configured with any of the two predefined actions.
Available Events:
Bridge Registered: After installing and registering a Bridge agent, this event initiates the relevant action that confirms the successful completion of the necessary configurations.
- Bridge Up: Listens to an inactive Bridge agent; when it is up and available for use, the event initiates the configured action to notify that the Bridge agent is functioning as intended and ready for use.
- Bridge Down: Monitors a bridge agent and triggers the configured action when the bridge is experiencing downtime or is not operational, which signifies an interruption in the normal functioning of the bridge server.
- Bridge Deleted: This event monitors the existence of a bridge, and when a user deletes a bridge through the user interface (UI), the specified actions are activated.
Configuration Options for Events:
For the above events, you can configure the following actions:
Alert: Sends an email notification to the designated user upon the occurrence of the specified event. Users can either utilize an already configured email template or create a new one.
Webhook: Triggers an API request when the specified events occurs. Users have the flexibility to employ an existing webhook created in the Qntrl account or set up a new one according to their preferences.
By choosing from these actions, you can customize the response to each event according to your needs.
To associate an action to an event:
Click the settings gear icon at the left pane.
Navigate to Advanced >> Bridge, and choose Events.
Select any of the events from the available options,
In Action Type, click the dropdown and select the desired action (Alert/Webhook)
Setting up an Alert: If you select 'Alert' as the Action Type:
In the 'Alert' field, pick an existing configured alert from the dropdown.
Alternatively, to create a new alert, click Create New. In the New Email window and provide the following details:
Name: Enter a name for the email.
Email template: Select an email template from the dropdown list.
Notify to: choose the designated person from the dropdown list.
Add Cc and Bcc fields if required.
Click Save, and a new email template will be created.
Configuring a Webhook: Similarly, for the webhook action type:
Click Save.
Edit Events
To modify a configured Event:
Navigate to(settings) >> Advanced >> Bridge >> select Events.
On the loaded list of events, click on the event name you want to edit.
You can now make changes to the Name and the configured Action.
After making the desired modifications, click on Save.