Brevo Events API

Before setting up activity tracking on your Odoo website, get a client key and an API key for server-side integration.

Client Key

The module integrates Brevo Tracker into your Odoo website using a client_key. To obtain it:

• 01
  Log in to your Brevo.com account
• 02
  Go to Settings — Automations and open Brevo Tracker

• 03
  Select the JS Tracker installation option

• 04
  Copy the value of the client_key parameter in step 2

API Key

To get an API key, which acts as the access token for server-side integration with Odoo:

• 01
  Log in to your Brevo.com account
• 02
  Go to Settings — SMTP and API, and on the API keys and MCP tab, click Generate API key

• 03
  Enter a Key Name, select an Expiry, choose the Full access option to grant all permissions, and click Generate

• 04
  Copy and save the generated API key

After installing the module, go to the website settings and enable the Activate Tracking option in the Enhanced Website Tracking section. To test your website tracking and view tracking events in the browser console, temporarily enable the Debug Logging feature.

The module tracks e-commerce events on an Odoo website using a tracking service. It sends tracking events to Brevo along with product information and user-provided data. You can send data via both the Brevo Tracker and the Events API. Add and configure the tracking service for your Odoo website.

Adding a Tracking Service

Go to the Website — Configuration — Tracking — Services menu and click New to add a new tracking service for your Odoo website.

Firstly, fill in the following fields:

• Specify a Website (if multiple websites are used)
• Select Brevo Tracker as the service Type
• Paste your client_key into the Key field

Then select the product identifier type and the product category to send to Brevo.

If products have attributes and variants, choose Product Variant ID in the Item Type field; if not, select Product Template ID.

Select the desired Category Type: an eCommerce Public Category or an internal Product Category.

Activating the Events API

Activating the Brevo Events API requires an access token and event logging.

Saving tracking events in internal Odoo logs is mandatory for server-side integration.

Enable the Internal Logs option on the Options tab.

Next, activate the server-side integration in the API section — enable the Activate option and paste the generated API Key into the Access Token field.

For instructions on how to generate an API Key, see the Getting Keys section.

Contact Identification

Advanced matching allows you to identify contact details of website visitors and supply this information to Brevo for SMS and email campaigns and other automations. Open the Advanced Matching tab and specify what information the tracking service should send. The Enable Allowed button allows you to enable all available options for this tracking service.

Checking the Hashed checkbox next to the Customer Name and Phone options indicates that customer information is protected using hashing, complying with Brevo requirements.

Customer data source

Use the Sale Order Partner value for the Customer Data Source, as it provides more user details in case you allow guest checkouts without registration.

The tracking service sends events from the internal log via the Brevo Events API at a set interval.

To view internal tracking events, go to Website — Configuration — Tracking — Logs or click the Logs button at the top of the tracking service form.

Enable the State and API Sent Date columns to display the status and date of event transmission to Brevo via the Events API.

Automatic Event Transmission

The module automatically sends tracking events using an Odoo scheduled action. By default, it runs every 30 minutes, and you can adjust this interval to suit your requirements.

The list of scheduled actions is located in Settings — Technical — Automation — Scheduled Actions and is accessible only in Developer Mode.

Manual Event Transmission

To send tracking data manually, select tracking logs from the list or open an individual log record and click Send Event.

The module includes additional settings available in Developer Mode.

Product Identifier

The module uses the Product ID field as a unique product identifier. To use a different value, specify another product field containing the desired identifier on the Technical tab:

The specified product field should provide non-empty values and remain unique for each product. Otherwise, the tracking data for this product becomes unusable.

Purchase on Portal

To track portal purchases, enable the Track Purchase on Portal option:

Exclude Delivery

The next available setting for tracking services is Exclude Delivery. When enabled, the service excludes delivery lines from sales orders in tracking data transmissions:

Exclude Rewards

To exclude reward order lines from tracking data, enable the Exclude Reward option:

Add to Cart

By default, the module tracks the actual addition of a product to the cart. To track the event upon clicking the button without waiting for the actual addition to the cart, perform the following steps:

• Navigate to Website — Configuration — Websites
• Open the website on the Enhanced Tracking tab
• Enable the Add to Cart on Click option

Tracking the actual addition might fail if third-party modules modify the logic. In this case, this option allows for event tracking by binding it to button selectors used in native Odoo website templates.

Purchase

To track purchases only after a successful payment transaction, enable the Track Confirmed Purchases only option:

This option only affects the event transmission through the tracking service; the internal log records the event regardless.

If business logic considers an order with a Pending payment status as a purchase, enable the Track Pending Purchases too option as well.

The module allows you to disable the JS script to verify event transmission via the Brevo Events API server-side integration. To do this, follow the steps below.

First, open your Brevo Tracker tracking service in Odoo on the Options tab and enable the Remove JS Script option to prevent sending events to Brevo via the JS script before executing event API calls.

Now, perform several actions on your website, such as browsing the product list or adding an item to the cart.

For testing, log out of Odoo or use a different browser, as website event tracking does not work for internal Odoo users.

After that, go to the log list and send these events manually. If the status is Warning or Error, review the API Response value on the Technical tab for detailed information.

Brevo only allows API requests from authorized IP addresses. Verify your authorized IP addresses in the security settings of your Brevo.com account.

The Sent status indicates that the event was successfully transmitted via the API.