v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Events

Create an event

Create an event to track a contact's interaction.

post/events

Request body

event_namestring required

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.

event_datestring

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.

contact_propertiesobject

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_propertiesobject

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.

Example request

{
  "event_name": "video_played",
  "event_date": "2024-02-06T20:59:23.383Z",
  "identifiers": {
    "email_id": "jane.doe@example.com",
    "phone_id": "+91xxxxxxxxxx",
    "whatsapp_id": "+91xxxxxxxxxx",
    "landline_number_id": "+91xxxxxxxxxx",
    "ext_id": "abc123"
  },
  "contact_properties": {
    "AGE": 32,
    "GENDER": "FEMALE"
  },
  "event_properties": {
    "video_title": "Brevo — The most approachable CRM suite",
    "vide_description": "Create your free account today!",
    "duration": 142,
    "autoplayed": false,
    "upload_date": "2023-11-24T12:09:10+01:00"
  }
}

Response

An event posted