Synerise Menu


We recommend sending data through SDK not directly to tracker.

Synerise tracker accepts requests with PUT method, which should encode JSON content in body – see example below. We have several types of events you should use regarding what type of event are you sending: client data update, clients events, external system data.

This fields are mandatory:






your event’s category, should identify the event’s enviroment and consist of:

1. trigger

2. enviroment

3. source

4. medium



name of the action, always in camelCase consisting of:





event’s label or nice name


string []

key-value arrays describing the events parameters, can be as many as you like

  • Category triggers: in Synerise if an action is performed by client the trigger will be „client”
  • Category enviroment: here you have to provide in what enviroment the event occured.
    Choosing the right event category depending on event’s enviroment:

web desktop: client.web.browser

web mobile:

mobile app: client.application

  • Category source: this indicates the events origin which can be: application, browser, pos or web
  • Category medium: defines the context such as: screen, page, event.
  • Action object: indicates on which element event occured. You will mainly use client or customEvent.log
  • Action action: describes the action for example createOrUpdate, youOwnEvent
  • Label: this field should contain information about the event for example „Log in”, „Button X clicked”.
  • Params: here you can put additional attributes you want to send with the event. Remember if sending events related to clients alway send customIdentify. Params are keys and value.

Example events:

Remember that you need to send the client’s customIdentify in params to bind the sent event with a specific client.

Event types:

– client custom data
All events which send information about client such as personal data should be sent not as a custom event but a client’s data update. You can check the list of default personal data fields in the appendix. But if your custom event will send personal information please ensure that you add $ before a client default data field it will update clients profile.
Event responsible for updating client data is: createOrUpdate, event’s category is set depending on the environment and customIdentify is mandatory in params.

– client events
Events like button clicked or any that don’t reload the website should be send using customEvent.log Look at the example below:

After sending customEvent.log you will be able to segment clinents by params for example:

If you send an event that a client has clicked pause button during watching Jaws movie like this:

Note: segment conditions are independent from each other. Suppose segment with conditions genre=”horror” and director=”Steven Spielberg”. It will match all clients who watched any horror movie and any movie directed by Steven Spielberg (which may be two separate movies).

Matching clients by multiple parameters from the same event may be achieved by deliberately designed events. For example clients who watch horrors directed by Steven Spielberg will be easily extracted using condition type=”Steven Spielberg’s horror” from the following event: