Real-time events

What are events and how can they be leveraged in Xtremepush

Events play a significant role on realtime marketing and segmentation. It is possible to gather various events from systems such as session started or custom events that you can define based on your needs via Xtremepush SDKs and APIs.

What is an event?

An event is an occurrence that happens at a particular time. In the Xtremepush platform, events can be triggered by customer behaviours (page viewed, app opened, etc.), system behaviours (message sent, message opened, etc.) and external updates (CRM changes, etc).

View and edit events

To view or edit the events already defined for a project, navigate to Data > Data Manager > Events.
The list can be filtered by using the search fields at the top of the table.
An event can be edited or deleted using the icons on the relevant table row.


Renaming Events

Events match by name. If you do any change on XP platform, you need to be sure that change is also made on SDKs or APIs. Otherwise, when you change the event name in events page and then the next event hit happens it will create a 'new' event with the previous name.

Create a new event


An event is created in your project when you fire it for the first time or you can also manually create it by navigating to Data Manager > Events > Create event.

For more details on how to fire an event from your web or app, you can check these documents:

Import events

It is possible to import historical events in bulk from your own data store into an Xtremepush project, which can then be used for segmenting users. Even if the data predates the implementation of the SDK to your site or app the data can still be used for segmentation.


Before setting up an event import, make sure that the event already exists in the Data Manager page. If it doesn't, create it from Data > Data Manager > Events > Create event.

Set up the import

To import an event, go to Data Manager > Events > Import Events.

In the Create Import page, enter a name for the import so that you can easily identify it later.

Select Events as the type of data you want to import, then select the specific event you want to import, for example, bet_placed. Select the data source from which to import the file: File Storage (which requires having an SFTP integration configured in your project) or File Upload.

To make sure that each event can be linked to the right user profile in your project, the file must have a user ID, customer ID, or email address linked to each row in the file. Press Next Step.

It's compulsory also for the file to have a timestamp against each entry in the file. The timestamp must be in unix format. If the timestamp has a different format, the system will try to convert it, but if it fails to convert it that row will not be imported.

Data mapping

On this page, map the columns from the import file, which appears on the left and shows sample data in the middle to attributes in your project.

You can select which attribute in your project you want to map the data to by selecting an option from the Map to dropdown. There are four mapping options.

  1. Dont import
    If you wish not to import a specific column of data.
  2. User Identifiers
    Select a User Identifier from the dropdown if you want to match a column that contains user identifiers in the import file to a user identifier in your project in Xtremepush.
  3. Event MetaData
    Select this option to map data like the event timestamp from your import file to your project.
  4. Event Properties
    Select this option to import any other string to your project.

After the data mapping has been completed, press the Run Import button. The system will take you to the task history details page where you will be able to review the progress of the import and check on any errors (if any).

The imported data will show up in the respective user's profile under the Events tab.

Automate the import

You can automate the importing of events by going to Data > Automations and clicking on import.

Review our dedicated guide for more details.

How to use events

Events can be used for:

  • Segmentation : an event can be used as a condition to create a segment
  • Triggering realtime campaigns: event triggered campaigns can be created and also the event can be filtered on the Event tab by its property or value.
  • Data and Analytics: events can be analysed from the Analytics > Behaviour > Tags and Events section.