Creating Events

You can create events in two ways:

• Automatically (via API, after setting up the launch conditions for regular workflow and workflow based on changes in the contact's field)
• Manually.

The event sent via API / SDK is automatically registered in Other category with the name with which you stream it to us. After the first request, it will appear in your account, and you can see it in the Automation → Event types section.

But if you want to use one of our system events, firstly, you need to create it and specify its category.

Creating an Event Type

To create an event manually:

1. Go to Automation → Event types and click New event type.

2. Fill in Name (required).

3. Fill in Key (required). A key is a unique event identifier that is registered in the system. You can fill in any text in Latin, with numbers allowed, for example, click, sale1, etc. The main requirement is that the key should be unique for every event.

4. In Category, select the necessary event category.

5. If you enable the Segmentation by events option, switch Use event for contact segmentation. The availability of this option depends on your tariff plan. To enable it, please contact [email protected].

6. Enable Validate parameters.

   

   If the option is enabled, the system only accepts an event whose structure complies with the validation rules.

More about validating event parameters >

7. Click Add.

After this, a new event type appears in the Event types list.

Now you can link the created event to the workflow so it will run the automated campaign.

Viewing, sorting, and validating event parameters

Go to Automation → Event types to view available event types.

Activity Statuses

To sort events by activity, select the appropriate filter:

• All statuses
• Active
• Inactive

At the top of the list, is a set of additional filters to sort events by specific metrics.

You can sort from highest to lowest value and vice versa.

Event Type Dependencies

Event type dependencies represent the relation between the event type and a workflow or dynamic segment.

To filter event types by dependencies, select the tab:

• All dependencies
• Launch workflow (specified in the workflow start configuration),
• Stop workflow  (specified in the workflow stop configuration),
• Enabled segmentation (events are used to build a dynamic segment),

• Without dependencies.

📘

Note

One event type can have multiple related workflows and dynamic segments. In this case, dependencies are grouped, and their quantity is displayed.

Event types created for regular workflows and workflows based on contact field changes contain:

• Segment name, segment ID.
• Contact field name, contact field ID.

Clicking on a dependency opens the Dependencies of event type window with detailed information about each related workflow and dynamic segment.

To view and edit related objects, click on the preview icon.

Daily Statistics

Activate the checkbox on the tab in the left menu to filter event types and workflows with declining metrics, as well as events with errors

• Volume decline
• Launched workflows decline
• With errors

Declining metrics are displayed in orange so that you can promptly notice events that require attention.

Additional Actions with Event Types

Clicking on the three dots in the event type field reveals a menu with the following options.

Analytics

Charts display metrics of event and workflow activity, and error metrics, and include the following categories:

• Total events count
• Launch workflow
• Stop workflow
• Contact not found
• Parameters errors

More about event analytics  >

Event history

This option shows the launch history of the selected event.

Parameters validation / Structure preview

Add validation parameters so that the system accepts only events that correspond to them.

If an event is used for contact segmentation and has already been transmitted to the system, you can view its structure on the Structure preview tab and compare event parameters with the validation rules you've set. You can also copy the structure parameters.

📘

Note

When transmitting new parameters, they will add to the event parameter structure, while the existing ones will remain unchanged.

Delete

The event is deleted along with its history, and recovery is not possible

Event Search

To find a specific event, enter its name in the search bar.