Event definitions

The activity of your website’s visitors is saved in Synerise as events. For example, opening the page is saved as the page.visit event.
Sometimes, events also define the activities directed to the user, such as sending an email (message.sent) or a web push notification (webpush.send).
The application can generate these events thanks to the implementation of a tracking code and/or mobile SDK.

The events are identified by their action property, which takes a <domain>.<occurrence> format. The event can also receive a human-readable label that is displayed instead of the action.

You can add custom event definitions in the following ways:

  • Through the interface (described in this article)
  • Through the API by using the Custom event method. When you use that method to send an action which is not known in the system, a definition is created automatically from the new data.
Default events

page.visit transaction.charge product.buy client.addTag
client.removeTag session.start session.end client.automationPathStart
client.automationPathStep client.automationPathEnd client.updateData client.applicationStarted
dynamicContent.click dynamicContent.show form.submit marketingAgreement.turnOff
marketingAgreement.turnOn message.notSent message.sent newsletter.click
newsletter.confirmSubscribe newsletter.dropped newsletter.hardbounce newsletter.unsubscribe
newsletter.softbounce newsletter.spambounce screen.view sms.send
webpush.click webpush.send webpush.show webpush.subscribeBlock
button.click client.add client.applicationStarted client.createOrUpdate
datalayer.add datalayer.purchase datalayer.refund datalayer.remove
event.log form.submit product.addToCart push.send
push.click push.send screen.click slider.change

Requirements


  • Implement tracking codes into your website.
  • You must be granted a set of permissions that allows access to Data Management and performing operations there.

Adding event definitions


  1. Go to Data Management icon Data Management > Events.
  2. Click Add new event.
    Result: A pop-up appears.
  3. In the Event source field, type the name of the event’s source action in the Synerise format, for example: custom.event. The source action displays after hovering over the event on the list of events and in the activity list on a customer’s profile.
  4. In the Event name field, type a human-readable name. This is the name displayed on the list of events.
  5. Optionally, in the Description field, you can write an explanation of the event’s purpose.
  6. In the Event permissions section, you can select the ways of authorizing events (you can find more information about Event permissions here):
    • Accept anonymous Customers
    • Identify customer without JWT token
    • JWT token verification
  7. To complete the process, click Save.
    You can now add parameters to this event definition.

Editing event definitions

You can update an existing event. Some settings cannot be edited.

  1. Go to Data Management icon Data Management > Events.
  2. In the list of events, find the event you want to edit.
  3. Click the Three dot icon.
  4. From the list, select Edit.
  5. In the window that appears, edit the data in the same way as when adding the definition.

Changing event visibility in analytics

By default, each event is visible in analytics.

You can enable or disable the visibility of an event in the analytics:

  1. In the list of events, hover over the visibility icon of an event.
  2. Switch the toggle that appears.

Adding parameters

See Event parameters and enrichment.

Removing event definitions

  1. Go to Data Management icon Data Management > Events.
  2. In the list of events, find the event you want to edit.
  3. Click the Three dot icon.
  4. From the list, select Remove.
  5. In the dialog that appears, confirm by clicking OK.
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.