Events tab

Fine tune how your campaign will be triggered by an event

The Events tab is where you specify the rules and behaviour of the real-time event trigger for your campaign. This tab is only available when creating an event triggered campaign, or for in-app / on-site campaigns.

Event data may be passed from:

Learn more about real-time events in our dedicated guide.

📘

Events are required for some campaign types

In-app and on-site messages campaigns (Campaigns > Create campaign > In-App / On-site message) can only be configured as a response to real-time events from your website or your mobile app.

Select event

This section allows to select the event which will trigger the notification. Events that have been previously manually created from Data > Data Manager > Events or fired from your website, app or via the external API at least once will appear in the dropdown menu.

Type the name of the event to search for it.Type the name of the event to search for it.

Type the name of the event to search for it.

In-app / on-site campaigns also include an option to trigger the campaign on session start (which is only applicable for in-app campaigns), as well as a custom event as above.

👍

Session start event

For more details on how to trigger session start events from your mobile apps see our dedicated Android and iOS guides.

Filter events

Set whether all hits to the selected event will trigger the notification or when an event occurs and filtering conditions are passed.

Conditions can be set in relation to event values or nested event properties. An event value corresponds to a string (a simple value like homepage), so this filtering condition will be able to perform evaluations in relation to this value (for instance whether something is equal/not equal to this value).

With the configuration shown in this example, the message will be triggered when the value of the pageview is equal to homepage.With the configuration shown in this example, the message will be triggered when the value of the pageview is equal to homepage.

With the configuration shown in this example, the message will be triggered when the value of the pageview is equal to homepage.

An event property is a complex value, expressed with a JSON object (for example:

{
   "order_no": "ABC123",
   "order_date": "2021-03-14",
   "price": 304.67,
   "quantity": 5
}

Filtering based on event properties allows you to perform evaluations in relation to the information contained in this object (for instance, that this property contains a specific value).

With the configuration shown in this example, the message will be triggered when the JSON object related to order_completed contains a value called price which is greater than 300.With the configuration shown in this example, the message will be triggered when the JSON object related to order_completed contains a value called price which is greater than 300.

With the configuration shown in this example, the message will be triggered when the JSON object related to order_completed contains a value called price which is greater than 300.

Add a delay

Select whether you want to send the message immediately once the event is fired or with a delay. Available options:

  • Send immediately: The event will trigger a notification immediately.
  • Send with a delay: Set a delay before the notification is triggered.

📘

Delay options are not available for in-app / on-site campaigns.

Triggering limits

This section allows to establish limits on the number of times a notification will be shown.

  • Maximum number of triggers: User/device notification limit is the maximum number of notifications a user/device can receive either per day or per campaign. If they continually hit an event, they will not receive more notifications than specified.
  • Number of events before the first trigger: defines the number of times per day or per campaign an event must be hit before the user/device receives a notification.

Updated 28 days ago


Events tab


Fine tune how your campaign will be triggered by an event

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.