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.

Event Type Management

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

Activity Statuses

Event types can be Active or Inactive depending on the activity status in the system.

To sort events by activity, click on the tab:

• All statuses
• Active
• Inactive

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
• Stop workflow
• Enabled segmentation
• Without dependencies

List of Event Types

The general list displays the following information:

1. Event type

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

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

The numbers in the event type name are the IDs of the dynamic segment contact field.

2. Dependencies

The Dependencies column displays workflows and dynamic segments related to event types. An empty field means that the event type has no dependencies.

📘

Note

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

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 eye icon.

3. 24 hours volume: number of event types in the last 24 hours.

4. 24 hours launched workflows: number of workflows launched for this event in the last 24 hours.

5. 24 hours errors: number of workflow errors in the last 24 hours.

6. Use event for contact segmentation (switch to activate/deactivate).

7. Additional management options.

Clicking on the three dots in the event type field reveals a menu with options such as:

• Event history: go to the Event history section.

• Validate parameters: configure validation rules.

• Structure preview: preview the structure of the event type, with parameters that can be copied.

The Structure preview option is available for enabled segmentation events.

📘

Note

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

• Delete: delete the event type.

To search for event types in the general list, use the search bar by event name.