The Brevo plugin for Magento 2 allows you to sync your store's customer and order data with your Brevo account. This allows you to send targeted emails and SMS campaigns, create marketing automations, and improve customer engagement.

Before you start

Make sure you have access to your Magento 2 admin panel and Magento server as a file system owner.

Install the Brevo plugin for Magento 2

Step 1: Verify pre-requisites

Before installing the Brevo plugin on your Magento store, ensure that the following pre-requisites are met:

1. Log in to your Magento server as the file system owner.
2. Check your composer.json file to ensure the repo.magento.com repository is included:
   

   repositories": [ { "type": "composer", "url": "https://repo.magento.com/" } ]

3. Retrieve your access keys from Adobe's website.
4. Add your access keys to the auth.json file in your Magento installation folder. If the file is missing, open the following dropdown to view a sample structure you can use:
   Sample auth.json file

   { "http-basic": { "repo.magento.com": { "username": "<public-key>", "password": "<private-key>" } } }

Step 2: Install the Brevo plugin for Magento 2

Install the Brevo plugin directly from your Magento server.

1. Log in to your Magento server as the file system owner.
2. Navigate to the folder where your Magento shop is installed.
3. Install the Brevo plugin by executing the following command:
   

   composer require brevo/magento2-extension

4. (Optional) If you encounter an error, execute the following command:
   

   sudo composer require brevo/magento2-extension

   and confirm to proceed as the root user by typing yes.
5. Update your Magento instance by executing these commands in sequence:

   sudo bin/magento module:enable Brevo_Core

   sudo bin/magento setup:di:compile

   setup:upgrade

6. After the setup is complete, log in to your Magento admin panel.

The Brevo plugin is now installed and needs to be activated. 

Step 3: Activate the Brevo plugin for Magento 2

Activate the Brevo plugin to connect your Magento store to your Brevo account.

1. In the sidebar menu, go to Stores > Brevo Configuration.
2. Click Activate Plugin.
3. Next to the Brevo Integration, click Activate.
4. Click Allow to grant Brevo access to the necessary settings for the integration.
5. Click Allow access to grant Magento 2 access to your Brevo account.
6. Click Activate to connect your Magento 2 account. You are redirected to the plugin's settings.

Access the plugin's settings in Brevo

Access the plugin's settings in Brevo. From there, you can manage the Brevo plugin settings, including customer synchronization, visitor tracking for your store, and more.

1. Log in to your Brevo account.
2. Click your account name and select Plugins & Integrations.
3. Go to the My Integrations tab.
4. Next to the Magento 2 plugin, click the three dots icon and select Edit settings.
   

Sync your Magento 2 customers to Brevo

Sync your Magento 2 store's existing and new customers to Brevo.

1. From the plugin's settings, go to Contact Synchronization.
2. Activate the Sync your store contacts to Brevo option. By activating this option, all store contacts added, updated, or deleted in Magento 2 will automatically be reflected in Brevo.
   
3. From the dropdown, select if you want to perform the sync from a customer list or group.
4. Choose how you want to sync your contacts:
   
   Sync all contacts to a Brevo list Sync store groups to Brevo lists

   1. From the dropdown, select the A list option. By default, contacts are added to the list named Magento 2 in the Integrations folder.
   2. (Optional) To choose a different list or create a new one, click Select another list.
      

   1. From the dropdown, select the A group option. 
   2. Click Assignment settings.
      
   3. Choose the Brevo lists where you want to sync specific store groups.
5. (Optional) Configure the following options, which are activated by default:
   
   1. Sync the state of contacts (subscribed/unsubscribed)
      Synchronize the subscription status of contacts from Magento 2 to Brevo. When a contact subscribes or unsubscribes in your Magento 2 store, the change will be reflected in Brevo.
      If you don't want to reflect their subscription status in Brevo, deactivate this option.
   2. Autoassign store contacts' attributes to Brevo contact attributes
      Automatically map the email address, first name, and last name of your store contacts in Magento 2 to contact attributes in Brevo.
      To map other attributes manually, deactivate this option and select Map attributes.
      
      💡 Good to know

      Only default Magento attributes can be mapped to Brevo contact attributes. Custom attributes cannot be mapped.
      
6. Click Save.

Sync your Magento 2 eCommerce attributes to Brevo

Sync your Magento 2 store's products, categories, orders, and customers to Brevo.

1. From the plugin's settings, go to Ecommerce Attribute Synchronization.
2. Activate the Enable the sync of e-commerce attributes to gain insights on your most valuable customers option. By activating this option:
   • All store products, categories, and orders will be synced to Brevo. 
   • All store customers who have placed at least one order will be synced to Brevo.
   • Contacts who have opted in to receive email communications via the store interface will be subscribed in Brevo, while all other synced contacts will be blocklisted in Brevo.
     
3. Click Confirm.
4. Under the Sync Statuses section, monitor the sync status of your eCommerce attributes. The initial full sync of historical data may take some time to complete.
   
   
   💡 Good to know

   You can also monitor the sync status by selecting the Magento 2 plugin from the My Integrations page on your Brevo account.
5. (Optional) Click View Ecommerce Analytics to access your eCommerce dashboard where you can analyze different metrics, such as your revenue, product, and retention performances. To learn more, check our dedicated section in the Help Center.

After the sync is completed, any new product, order, and customer will be synced in real-time.

Manage your subscription confirmation settings

Use of one Brevo's subscription confirmation options and send double or simple confirmation emails when a contact submits a form on your Magento 2 store.

1. From the plugin's settings, go to Subscription Confirmation.
2. Activate the Use Brevo subscription confirmation options to manage opt-in settings option. By activating this option, you can choose to send double or simple subscription confirmation emails directly from Brevo.
3. Select if you want to send double or simple confirmation emails. To learn more, check our dedicated article FAQs - Why use a double opt-in sign-up form?.
   
4. Configure your subscription confirmation:
   
   Double confirmation email Simple confirmation email

   1. From the dropdown, select the double opt-in confirmation email template you want to send to contacts who submit your form. To learn how to create a double opt-in email template, check our dedicated article Create a custom double opt-in (DOI) email template for a sign-up form created in Brevo.
   2. (Optional) Enter the URL of the confirmation page contacts will be redirected to after clicking the double opt-in link in the email.
   3. (Optional) Select the final confirmation emails you want to send to contacts after they click the double opt-in link in the email.
      
   4. Click Save.

   1. From the dropdown, select the simple confirmation email template you want to send to contacts who submit your form.
      
   2. Click Save.

Track your contacts' actions on your Magento 2 store

Track your contacts' actions on your Magento 2 store and sync the related data to Brevo. This allows you to use the data in automations, such as automatically sending an email when a contact abandons their cart or completes a purchase.

1. From the plugin's settings, go to Behavior tracking.
2. Activate the Allow Brevo to track visitor actions on your store website in order to use this information for conditions and triggers in your marketing automation workflows option. By activating this option:
   • The Brevo tracker will be installed on your store to monitor visitor actions in real-time. To learn more, check our dedicated article FAQs - What is the Brevo tracker and how to install it?.
   • Activity data, such as product views, cart additions, and purchases, will be synced directly to Brevo.
     
3. (Optional) Configure the following options, which are activated by default:
   1. Track page visits
      Monitor when a contact visits specific pages on your store.
   2. Track the actions related to an abandoned cart
      Monitor when a contact adds or removes a product from their cart and tracks when they complete a purchase.
      
4. Click Save.

Send transactional emails from Magento 2 using Brevo SMTP

Send your store's transactional emails using Brevo SMTP. This helps you improve the deliverability of your emails.

1. From the plugin's settings, go to SMTP for transactional mailing.
2. Activate the Use Brevo to send your store’s transactional emails option. By activating this option:
   • Your transactional emails will be sent using Brevo SMTP.
   • Your transactional email statistics will be available directly in your Brevo account.
   • You can use Brevo's dedicated IPs and authenticate your domain to improve the deliverability of your emails.
3. Choose the sender you want to use for your transactional emails. The selected sender's name and email address will appear in the recipient's inbox as the source of the email.
   
4. Click Save.

Create automations for your Magento 2 contacts

Create automations using data from your contacts' actions on your store. For example, you can automatically send an email when a contact abandons their cart or completes a purchase on your Magento 2 store. 

To learn more, check our dedicated articles:

Send SMS messages for order and shipment confirmation using Brevo

Send SMS messages for order and shipment confirmation using Brevo.

1. From the plugin's settings, go to SMS Options.
2. Activate the Use Brevo SMS Options to send SMS to customers after order confirmation and shipment option. By activating this option:
   • Your SMS messages for order and shipment confirmation will be sent using Brevo.
   • Your transactional SMS statistics will be available directly in your Brevo account.
     
3. (Optional) Activate the Activate special characters option if your SMS messages contain special characters such as GSM characters, Unicode content used in non-Latin alphabets (e.g. Arabic, Russian), and emojis. Otherwise, special characters could be replaced when sending.
   
   
   ❗️ Important

   Activating this option will reduce the SMS character limit from 160 characters to 70 characters.
4. Choose if you want to send SMS messages for order confirmation and/or order shipment / for which events you want to use Brevo to send your SMS messages: 
   • Order Confirmation
     Your customers will receive an SMS when their order is confirmed by your server.
   • Order Shipment
     Your customers will receive an SMS when their order is shipped by your company. 
5. Customize your SMS messages:
   
   
   1. Sender: Enter a personalized name of 3-11 letters or 15 digits for your sender. We recommend using your company name to help your recipients recognize your brand. Avoid special characters such as GSM characters, Unicode in non-Latin alphabets (e.g., Arabic, Russian), and emojis.
      
      💡 Good to know

      Recipients in some countries (including the USA and Canada) cannot see sender personalization, which is displayed as a numerical short code. To learn more, check our dedicated article Short codes, long codes, and personalized SMS senders.
   2. Message: Enter the content of the SMS message your recipients will receive. You can personalize your SMS using predefined variables, such as {first_name} to include your customer's first name. Each SMS message can contain up to 160 characters (or 70 characters if special characters are activated), including spaces and line breaks.
      ❗️ Important

      You have to include an unsubscribe option in your SMS content. To learn more, check our dedicated article Include an unsubscribe option in your SMS messages.
   3. Send a test SMS: Send a test SMS to the phone number of your choice to check the display of your transactional SMS.
      
      ❗️ Important

      Sending a test SMS will be deducted from your SMS credits. 
6. Click Save.

Troubleshoot the installation of the Brevo plugin

If you experience any issues during installation, follow these troubleshooting steps:

1. Clear the Magento cache:
   1. In your Magento admin panel, go to System > Cache Management.
   2. Click Flush Magento Cache.
      
2. Log out and log back into your Magento admin panel.
3. If the issue persists, try reinstalling the extension.
4. If you still experience issues, contact our support team by creating a ticket from your account.

🤔 Have a question?

If you have a question, feel free to contact our support team by creating a ticket from your account. If you don't have an account yet, you can contact us here.

If you’re looking for help with a project using Brevo, we can match you with the right certified Brevo Agency partner.