Creating custom events

Custom events allow you to manually trigger automation workflows from dashboards. For example, on a vulnerability dashboard you may want to include a one-click button that sends an alert with patch information to the OT owner of a high priority asset. In the following sections we’ll show how this is possible with custom events.

Image


Creating a new event type
First, navigate to the admin console by clicking the “Admin console” text button from the left side panel or by clicking the Perygee logo in the top left. Then click “Data Modeling” from the left menu and then “Events.” If you’re already in the admin console, make sure “Events” is selected from within “Data Modeling.”

Then click the “New event type” button in the top right. A new event will be created and the Event Editor will open. First, enter a descriptive name for the event such as “Send Patch Details.”

Next, you will add event parameters. Event parameters can be static or dynamic (using dashboard variables) values that are passed to an automation. Note that at least one parameter must be added. After you click the “Add parameter” button, a modal will appear where you will give the parameter a name, type, and default value. The default value is optional. If you leave the value empty, you will define the parameters value when you connect the event to a button (see below).

When you’re done adding parameters, click the “Save” button in the top right to save the event and its parameters.

Editing an event type
From the admin console, select “Data Modeling” from the menu on the left and then “Events.” From the “Actions” column click the “Edit” button to open the Events Editor. Make and save your changes.

Connecting the event to a button
From the Dashboard Editor, drag and drop a button widget onto the canvas. With the button selected, under “On click” use the “Event” dropdown to choose the custom event you want to use. The “Event inputs” correspond to the event parameters you added during the event creation process. For each parameter, you have the option to set a static value or choose a dashboard variable as its value.

Connecting the event to an automation
When creating a new automation, choose the custom event you created from the list of triggering events. The Automation Builder will open and the custom event node will be present on the canvas. New actions can be added to the workflow that will be triggered when a button is clicked.