Events

Create an event

Create an event to track a contact's interaction.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

This endpoint expects an object.
event_namestringRequired

The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters, alphanumerical characters and - _ only.

identifiersobjectRequired
Identifies the contact associated with the event. At least one identifier is required.
contact_propertiesmap from strings to strings or integersOptional

Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: “FIRSTNAME”: “Jane” , “AGE”: 37

event_datestringOptional

Timestamp of when the event occurred (e.g. “2024-01-24T17:39:57+01:00”). If no value is passed, the timestamp of the event creation is used.

event_propertiesmap from strings to strings or integers or maps from strings to any or lists of anyOptional

Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field type are supported: string, number, boolean (true/false), date (Timestamp e.g. “2024-01-24T17:39:57+01:00”). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50Kb.

objectobjectOptional
Identifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account.

Response

Event posted

Errors