Search

Install the Brevo extension for Magento 2 (Adobe Commerce)

home-magento2.png
Install the Brevo extension for Magento 2

The Brevo extension for Magento 2 allows you to sync customer and order data to your Brevo database. You can then use this data to send targeted email and SMS campaigns, and transactional emails through Brevo.

Before you start

Gather the following information prior to installation:

Pre-requisites for plugin installation in Magento

Before installing the Brevo extension for Magento 2, ensure the following pre-requisites are completed:

  1. Log in to your Magento server as the file system owner.
  2. Verify that the repo.magento.com repository is included in your composer.json file: 
    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 located in the Magento installation folder. If you cannot locate the auth.json file, click the dropdown below to view a sample file:

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

Install the Brevo extension for Magento 2

To install the Brevo extension for Magento 2:

  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 extension by executing the following command:

    composer require sendinblue/module-sendinblue
  4. (Optional) If you encounter an error, execute the following command:
    sudo composer require sendinblue/module-sendinblue
    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 Sendinblue_Sendinblue
    sudo bin/magento setup:di:compile
    sudo bin/magento setup:upgrade

  6. After the setup is complete, log in to your Magento Admin Panel.

  7. Your extension is now installed. Go to Content > Brevo settings to access it.
    magento_access-extension_en-us.png

Installation troubleshooting

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

  1. Empty the Magento cache
    1. In your Magento admin panel, go to System > Cache Management.
    2. Click Flush Magento Cache.
      magento_clear-cache_en-us.png
  2. Log out and log back in to your Magento admin panel.
  3. Try re-installing the extension.

If your issue is still not resolved after following these troubleshooting steps, you can contact our support team by creating a ticket from your account.

Activate the Brevo extension for Magento 2

To activate the extension, you need the API key that you will find in your Brevo account.

Step 1: Retrieve your API key in Brevo

  1. In Brevo, click your account name and go to SMTP & API > API.
  2. Copy your API key.
    💡 Good to know
    To learn how to create a new API key, check our dedicated article Create and manage your API keys.

Step 2: Add your API key to Magento

  1. In Magento, go to the About Brevo tab.
  2. Select Yes next to Activate the Brevo module.
  3. Paste the API key into the API key v3 field.
    magento_api-key_en-us.png
  4. Click Update.

Automatically sync your Magento subscribers to Brevo

💡 Good to know
Subscribers are your opt-in contacts. Only opt-in contacts are synchronized with your Brevo account with the Brevo extension for Magento 2. To learn more about opt-in contacts, check our dedicated article How to ensure that my contacts list is legitimate and can receive my marketing communications?.

To automatically synchronize your Magento subscribers to your Brevo account:

  1. In Magento, go to the Contact Sync tab.
  2. Click Yes next to Sync your store contacts to Brevo.
  3. From the Your lists dropdown, select the Brevo list in which you want to sync your Magento subscribers.magento_contact-sync_en-us.png
  4. Click Save.

Your existing Magento subscribers are now synced and any new subscribers will be synced in real-time. You can view your subscribers directly from the Contacts page in your Brevo account. 

What data is synchronized?

💡 Good to know
The subscription status (subscribed/unsubscribed) of your Magento subscribers will also be reflected in Brevo.

If a contact subscribes via your website's default footer, only the EMAIL field will be synchronized.

If a contact creates a Magento account and subscribes to your newsletter, the following fields will be synchronized:

Attribute

Description

Type of attribute

EMAIL

Email of the contact

TEXT

NAME

First name of the contact

TEXT

SURNAME

Last name of the contact

TEXT

CIV

Civility of the contact

TEXT

MAGENTO_LANG

Language of the contact

TEXT

COMPANY

Company of the contact

TEXT

SMS

Phone number of the contact

TEXT

GROUP_ID

Group ID, relevant for multistore only

TEXT

STORE_ID

Store ID, relevant for multistore only

TEXT

DEFAULT_GROUP_ID

Groups the contact belongs to

TEXT

CLIENT

Your Brevo account will display "1" as a value when the contact is a client.

NUMBER

Manage transactional and subscription confirmation emails

The Brevo extension for Magento allows you to send transactional and subscription confirmation emails directly from Brevo. 

Step 1: Ensure the transactional platform is activated in Brevo

To send transactional and subscription confirmation emails, you first need to ensure the transactional platform is activated in your Brevo account.

  1. In Brevo, go to the Transactional page.

  2. If you see the Real time page, it means the platform is activated. If you see a message saying "The transactional platform has not been activated for your account", contact our support team by creating a ticket from your account.

Step 2: Activate Brevo SMTP for your transactional emails

Next, you need to activate Brevo SMTP in Magento. This will allow Brevo to send your Magento website's transactional emails (order confirmations, abandoned carts, etc.).

To do this, retrieve the SMTP key from your Brevo account and use it to activate Brevo SMTP in Magento:

  1. In Brevo, click your account name and go to SMTP & API > SMTP.
  2. Copy your SMTP key.
  3. In Magento, go to the Transactional Mailing tab.
  4. Select Yes next to Use Brevo to send your store's transactional mailing.
  5. Paste the SMTP key into the Brevo SMTP master password field.magento_brevo-smtp_en-us.png
  6. Click Save.

Step 3: (Optional) Activate subscription confirmation

Once you've activated Brevo SMTP in Magento, you can also choose to send your subscription confirmation emails directly from Brevo and select the confirmation email you want to send to your subscribers.

  1. In Magento, go to the Subscription Confirmation tab.
  2. Select Yes next to Use Brevo subscription subscription confirmation option to manage opt-in settings.
  3. From the Your lists dropdown, select the Brevo list in which you want to sync the contacts who subscribe through the subscription form on your Magento website's homepage.
    magento_subscription-confirmation_1_en-us.png
  4. Select the confirmation email you want to send to your subscribers:
    magento_subscription-confirmation_2_en-us.png
    • No confirmation: Subscribers are added to Brevo right after submitting your subscription form. They don't receive any email confirming their subscription.
    • Simple confirmation: Subscribers receive a confirmation email and are added to Brevo right after submitting your subscription form. You can select the confirmation email you want to send.
    • [Recommended] Double confirmation: Subscribers follow a double opt-in process and receive a confirmation email with a link. They need to click the link to complete their subscription and be added to Brevo. You can select the confirmation email and the page shown after form submission.
  5. Click Save.

Automatically sync your Magento orders to Brevo

❗️ Important

Order data is synced only for customers who are subscribed to your newsletter. If a customer places an order without subscribing to your newsletter, their order data will not be synced.

To automatically synchronize your Magento orders and their details (ID, date, and price) to your Brevo account:

  1. In Magento, go to the Order Sync tab.
  2. Click Yes next to Sync your customers' order data to sync your new orders.
  3. Click Yes next to Import your customers' order history to sync your existing orders.
    magento_order-sync_en-us.png
  4. Click Save.
💡 Good to know
You can then use this data to segment your contacts in Brevo and send targeted email and SMS campaigns, and transactional emails. For example, you could send a special offer to customers who have spent more than $100 on your website.

Automatically track your customers' actions on your website

The Brevo extension for Magento lets you track visitor actions on your website, including when they view specific pages and add products to their carts. This tracking functionality allows you to send abandoned cart emails to customers who leave their carts without completing their purchases.

To automatically track your customers' actions on your website:

  1. In Magento, go to the Behavior Tracking tab.
  2. Click Yes next to Allow Brevo to track visitor actions on your store website to install the Brevo tracker on your website.
  3. Click Yes next to Do you want to recover abandoned cart to track and send the three related events to Brevo: when someone adds a product to their carts (cart_updated), when they remove a product from their cart (cart_deleted), and when they complete a purchase (order_completed).
    magento_behavior-tracking_en-us.png
    ❗️ Important
    To send abandoned cart emails using these events, you then need to create an abandoned cart automation in Brevo. To learn more, check our dedicated series of articles About abandoned cart emails.
  4. Click Save.

Send SMS messages from Magento

❗️ Important
To send SMS messages, purchase SMS credits directly from My Plan > SMS credits in your Brevo account.

The Brevo extension for Magento 2 allows you to create and send SMS messages directly from your Magento 2 admin panel.

Configure low SMS credit notifications

To receive low SMS credit notifications:

  1. In Magento, go to the SMS tab.
  2. Click Yes next to You want to be notified by e-mail when you do not have enough credits?.
  3. Click Save.
  4. In the Email field, enter the email address where you want to receive notifications.
  5. In the Limit field, specify the SMS credit threshold for receiving alerts.
    magento_sms-settings_en-us.png
  6. Click Save.

Send SMS confirmations and campaigns

The Brevo extension for Magento 2 allows you to send order and shipment SMS confirmations, as well as SMS campaigns.

Order confirmation SMS Shipment confirmation SMS Send an SMS campaign

You can automatically send an SMS confirmation to customers after they complete an order on your website:

Step 1: Activate the confirmation SMS

To send confirmation SMS messages when an order is completed, first activate the option:

  1. In Magento, go to the SMS tab.
  2. From the Send SMS after order confirmation tab, click Yes.
    magento_sms_order-confirmation_en-us.png
  3. Click Save.

Step 2: Configure the confirmation SMS settings

We'll now configure the sender and content of the confirmation SMS message:

  1. In the Sender field, enter the name of your sender. This name will appear on the mobile phone of your recipients.
  2. In the Message field, enter the content of your SMS message. 
  3. (Optional) Personalize your SMS message using the following variables:
    • For first name use {first_name}.
    • For last name, use {last_name}.
    • For order reference ID, use {order_reference}.
    • For order price, use {order_price}.
    • For order date, use {order_date}.

     
    magento_sms-confirmation_settings_en-us.png
  4. Click Save.

Step 3: (Optional) Send a test SMS

❗️ Important
The test SMS will be deducted from your SMS credits.

To make sure your SMS message is correctly formatted, you can send a test SMS to the phone number of your choice:

  1. In the Send a test SMS field, enter the phone number to which you want to send the SMS message.
  2. Click Send.

🤔 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 expert partner.

💬 Was this article helpful?

1 out of 5 found this helpful