Skip to main content

Installing the Magento 2 plugin

home-magento2.png

Download the Extension

The Brevo extension for Magento 2 let you manage Magento email and SMS functionalities but also your subscribers.

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

Before you start

You will need to gather the following information prior to installation and use:

  • Brevo account credentials
  • Brevo API v3 (Accessible from Settings > SMTP & API in your Brevo account)
  • Magento 2 website root directory access
  • Magento 2 website admin panel access

To use all extension features, please ensure that your Brevo account is validated to send email and SMS messages from the Brevo Campaigns and Transactional platforms.

To send SMS messages, please purchase SMS credits in your Brevo account by navigating to My plan > SMS credits.

Install the extension

There are two methods for installing the Brevo extension for Magento:

Method 1: Install the extension using a zipped file:

  1. Download the Brevo extension from the Magento Marketplace
  2. Unzip the file
  3. In your Magento 2 root directory, create the folder app/code/Brevo/Brevo
  4. Move the extension’s unzipped files and folders to the new folder in your root directory
  5. In the command line (using “cd”) navigate to your Magento 2 root directory
  6. Run the following commands in order:

sudo bin/magento module:enable Sendinblue_Sendinblue
sudo bin/magento setup:di:compile
sudo bin/magento setup:upgrade

Your extension is now installed and accessible from the left navigation menu in your Magento 2 back office: Content > Brevo settings.

Method 2: Install the extension using the MagentoAdmin interface:

  1. Add the Brevo extension from Magento Marketplace
  2. Go to System > Web Setup Wizard
    Magento_EN_1-0.png
  3. Go to System Configuration
    magento_system-config_EN-US.png
  4. Input your public access key and private access key
  5. Click Save Config
    Magento_EN_1-2.png
  6. Go to Extension Manager
    magento_extension-manager_EN-US.png
  7. The Brevo extension should now be included in your list of available extensions
    Magento_EN_1-4.png
  8. Click Install and follow the steps on-screen
    Magento_EN_1-5.png

Installation troubleshooting

If you experience any issues during installation, please follow these troubleshooting steps and re-try installation before contacting Brevo or Magento support teams. 

  1. Empty the Magento cache.
  2. Log off and log back on as Magento administrator
  3. Check Stores > Configuration > Advanced. The "Sendinblue_Sendinblue" module must be activated.

Access and activate the Magento 2 extension

❗️ Important
To use the Magento extension, you must first create a Brevo account and make sure you have added and validated a sender address.

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

  1. Click your name on the top-right side of the screen
  2. Go to SMTP & API
  3. Copy the API v3 key which is compatible with plugins
    api_v3.png
  4. After you have copied the API key, login to your Magento website
  5. Go to the Brevo extension
    Magento_EN_2-2.png
  6. On the About Brevo tab, activate the Brevo module by selecting Yes and pasting the API key into the Brevo extension settings
    magento_settings-SIB_EN-US.png

Automatically synchronize contacts from your Magento website with your Brevo account

By selecting Yes, new subscribers to your e-store newsletter will now automatically be added to the contacts database in your Brevo account. You can select the list to which new subscribers will be saved.

magento_contact-syn_EN-US.png

Access the list of contacts in which you have synchronized your new subscribers directly from the Contact tab of your Brevo account. You will be able to find all the data provided by these subscribers during their subscription in this list.

Manage subscription confirmation 

If you want to use Brevo to manage subscription confirmation from your Magento website, select Yes.

magento_subscription-confirmation_EN-US.png

Once this option has been selected, select a Magento default subscription form or choose a custom one from the list that will be activated on the home page of your Magento website. (partie supprimée) If you choose a double opt-in confirmation, you can also redirect your customers to a landing page or a specific page of your website. You can also choose to send a confirmation email that will automatically be sent to confirm their subscription. You can choose a default template or a custom one from the list.

❗️ Important
To send subscription confirmation emails, you must make sure that your SMTP account for transactional emails is activated. Otherwise, no confirmations will be sent. If your SMTP account is not automatically activated, you can contact our support team for immediate assistance. After activatating your SMTP account, you must enable your Brevo SMTP on the Transactional Mailing tab of Magento to be able to send your subscription confirmation emails. To learn more, check our dedicated section Optimize the deliverability of your transactional emails.

What data is synchronized?

If a contact has subscribed via the website default footer, only the EMAIL field will be synchronized.

If a contact has created a Magento account and subscribed 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

Automatically track sales with Brevo

Check this option to automatically import details of your customers' orders into your Brevo database. This will show you the sales generated by your customers in the last X days. It may then be used to segment your database based on sales (e.g. provide a special offer to your VIP customers).

magento_order-sync_EN-US.png

Automatically track your customers' behavior on your website

Check this option to track your customers' actions on your website. You can also check the second option to automatically send an email to remind your customers of their abandoned cart on your website. 

magento_behavior-tracking_EN-US.png

Optimize the deliverability of your transactional emails 

❗️ Important
You must make sure that your Brevo SMTP account has been activated.

By selecting Yes to activate Brevo SMTP, your transactional emails (order confirmations, password resets, etc.) will be sent via the Brevo SMTP. 

magento_transactional-emailing_EN-US.png

Send SMS/text messages 

Brevo also lets you send SMS directly from your Magento back office, such as:

  • Order confirmation SMS,
  • Order shipment SMS,
  • Campaign SMS, e.g. countdown to the sales.

When you send campaign SMS to your subscribers/customers from this interface, the campaign will automatically be created in your Brevo account. You can then check your campaign report (SMS delivered, opened, clicked on, etc.) from your Brevo account. If you only send your campaign to one contact, it will not be created in your Brevo account.

You can personalize your SMS with attributes that exist in your Brevo database as shown in the screenshot below, e.g. {first_name}. 

magento_sms-campaign_EN-US.png

If you would like to create a targeted segment to use in an SMS campaign, it must be created within your Brevo account. Within the back office of your Magento website, the possible targets are limited to:

  • All your Magento contacts
  • Magento contacts subscribed to your newsletter
  • A single contact

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