Brevo tracker and eventsREST implementation

Track custom events

Legacy Tracker Documentation

For the legacy tracker doc, check our guide here.

This endpoint lets you to capture events and additional information about the events. A cURL request is mentioned below:

1curl --request POST \
2     --url https://in-automate.brevo.com/api/v2/trackEvent \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --header 'ma-key: YOUR_MA_KEY' \
6     --data '
7{
8    "email": "example@brevo.com",
9    "event": "cart_updated",
10    "properties": {
11        "additionalProp": "additional property"
12    },
13    "eventdata": {
14        "data": {
15            "added_product": [
16                {
17                    "currency": "EUR",
18                    "name": "Wrist watch",
19                    "type": "accessories",
20                    "price": "50.00"
21                }
22            ]
23        }
24    }
25}
26'

You can choose any value you want for the field event and pass any key-value in the field properties. Make sure not to use any reserved key (email or event) in the properties object. The attributes to track events are defined in the table below:

AttributeDatatypeDescriptionValue
emailStringEmail to identify the userjohn.doe@email.com
eventStringEvent to track”item_deleted”
propertiesObjectContains your custom fields. These user properties will populate your contact databaseSee example above
eventdataObjectContain the data you want to pass about the eventSee example above

Response

Response codeMessageDescription
204Event has been tracked successfullyNo content is shown in the JSON response but the event has been tracked
400Bad requestBad request occurs due to out_of_rangeModel, invalid_parameter, missingParameter