Backend custom events

Owned by Pim Reijnen
Last updated: Jan 29, 2024
3 min read

Met custom events kun je data verzenden, naar het API endpoint van Spotler Activate, om bepaalde informatie vast te leggen.

Inhoud

In Backend Custom events worden de volgende velden minimaal meegestuurd:

Veldlabel

Veldinhoud

Veldlabel

Veldinhoud

event

de naam van het event

email of userid

Emailadres of userid van het profiel

In de volgende omstandigheden zijn meer velden verplicht:

  1. Worden er meerdere talen gebruikt? → stuur dan ook language mee in de product array

  2. Worden er meerdere valuta gebruikt? → stuur dan ook currency mee in het event

Extra

In dit event kunnen extra datavelden uit de database worden meegestuurd. Wellicht zijn er in het Data Plan velden toegevoegd aan het event, die benodigd zijn voor het opzetten van use cases.

Een overzicht van de datavelden die je mee kunt sturen in het event, vind je hier: Datavelden

Allereerst dien je de custom datavelden aan te maken in Spotler Activate: Custom datavelden aanmaken

Vervolgens kun je deze meesturen met de veldlabel: custom_(naam van het veld).

In het geval van het custom dataveld custom_provincie dient dus bijvoorbeeld custom_provincie meegestuurd te worden.

Implementeren

De documentatie voor het implementeren van de Custom events via API Calls, vind je hier: https://Spotler Activate.tech/documentation#backend-api

Controleren

Na de implementatie kun je de volgende twee dingen controleren:

  • De respons op de API call

  • Het event in Spotler Activate

De volgende respons op de API call is correct:

De volgende respons is incorrect:

Het event kun je in Spotler Activate als volgt controleren:

  • Ga naar: https://Spotler Activate.tech/data/audience/new

  • Klik op custom

  • Stel de volgende regels in:

    • Events = (de naam van het custom event)

    • Name = Test backend custom event

    • Retention = 1

  • Save de audience en wacht tot de status ‘Live’ is

  • Ga naar Audiences

  • Klik op ‘Inspect’

  • Klik op een event ID

  • Controleer de volgende velden in het event:

    • Created at: is dit een tijdstip na de implementatie van de API Call? Zo niet, selecteer een ander event ID.

    • Api inserted & api verified: bevat een van deze velden ‘yes’? Dan is het event correct geïmplementeerd. Zo niet, controleer de implementatie.

Meer informatie over de backend API vind je hier: https://Spotler Activate.tech/documentation#backend-api

Â