POST /events/batch
Create multiple events to track contacts' interactions in a single request.
Servers
- https://api.brevo.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
[] |
Array | Yes | |
[].identifiers |
Object | Yes |
Identifies the contact associated with the event. At least one identifier is required. |
[].identifiers.whatsapp_id |
String | No |
whatsapp associated with the event |
[].identifiers.phone_id |
String | No |
SMS associated with the event |
[].identifiers.ext_id |
String | No |
ext_id associated with the event |
[].identifiers.landline_number_id |
String | No |
landline_number associated with the event |
[].identifiers.contact_id |
Integer | No |
Internal unique contact ID. When present, this takes priority over all other identifiers for event attribution and contact resolution. |
[].identifiers.email_id |
String | No |
Email Id associated with the event |
[].object |
Object | No |
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. |
[].object.identifiers |
Object | No |
Identifiers for the object. |
[].object.identifiers.id |
String | No |
Internal object ID |
[].object.identifiers.ext_id |
String | No |
External object ID |
[].object.type |
String | No |
Type of object (e.g., subscription, vehicle, etc.) |
[].event_properties |
Object | No |
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. |
[].event_date |
String | No |
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_name |
String | Yes |
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. |
[].contact_properties |
Object | No |
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 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.