Backend custom events (EN)

Owned by vTranslator
Last updated: Jan 30, 2022 by Cherlain Gajapersad (Deactivated)
3 min read

With custom events you can send data, to the API endpoint of Squeezely, to capture certain information

Content

In backend custom events the following fields will be sent along as a minimum:

Field label

Field content

Field label

Field content

event

the name of the event

email

Email address of the profile

In the following circumstances more fields are required:

  1. Are multiple languages used? → Then also include language in the product array

  2. Are multiple currencies used? → also add currency to the event

Extra

In this event extra data fields from the database can be sent. Maybe there are fields added to the event in the Data Plan, which are needed to set up use cases

An overview of the data fields you can send in the event, can be found here:

First you need to create the custom data fields in Squeezely

Next you can send these with the field label: custom_(name of the field).

For example, in the case of the custom data field custom_province, custom_province must be sent along.

Implementing

The documentation for implementing custom events using API Calls can be found here: https://squeezely.tech/documentation#backend-api

Check

After the implementation you can check the following two things

  • The response to the API call

  • The event in Squeezely

The following response to the API call is correct:

The following response is incorrect:

You can check the event in Squeezely as follows:

  • Go to: https: //squeezely.tech/data/audience/new

  • Click on custom

  • Set the following rules:

    • Events = (the name of the custom event)

    • Name = Test backend custom event

    • Retention = 1

  • Save the audience and wait until the status is 'Live

  • Go to Audiences

  • Click on 'Inspect

  • Click on an event ID

  • Check the following fields in the event:

    • Created at: is this a time after the implementation of the API Call? If not select another event ID.

    • Api inserted & api verified: does one of these fields contain 'yes'? Then the event has been implemented correctly. If not, check the implementation.

More information on the backend API can be found here: https://squeezely.tech/documentation#backend-api