Joomla - 1. Installing & configuring the Brevo package

❗️ Important
We no longer provide support for this plugin.

Joomla-3D-Vertical-logo-light-background-en-2.png

Overview

In this tutorial, you’ll learn how to connect your Brevo account with your Joomla website by installing and configuring the Brevo package. Then, you'll be able to:

Before getting started

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

  • Brevo account credentials. If you don't have one, sign up for free.
  • Brevo API v3 key following the instructions here.
  • Joomla website admin panel access.

To utilize all package features, please ensure that your Brevo account has been validated and you are able to send emails from the Brevo Campaigns and Transactional platforms.

You'll also find the Brevo package in the Joomla Extensions Directory.

Installing the package

The process is similar to other Joomla packages. Once logged in your Joomla back office, click on Extensions > Manage > Install.

mceclip0.png

The installation package will:

  • Add files and tables to your website
  • Create a Brevo tab in the Components menu
  • Create submenu items for the specific parts of the Brevo component

On the install page, depending on enabled installer plug-ins, four common installation options are:

  1. Install from Web
  2. Upload Package File
  3. Install from folder
  4. Install from URL

1. Install from Web

If your website has "Install from Web" functionality enabled, go to Install from Web tab, then type "Brevo" in the search box. Click on the package title to open the listing, then click on the Install button. Once confirmed, the package will be automatically installed.

G3TtcJoEZ19e55W1_bDuA_03dXH0paIscYWgzTjhX4iU0PK0SVofKSe8V27WcaBIU66d5LEXvVyx7aLm6ZOs9210Kre-zFscb0CDiKxYvd8wZD1VeGtpw22gKEc6RrRwu6lRwPp9T_4D2dSP3g.png

2. Upload Package File

Z2vyz6E0YEOI3ZtiHVErQKayhXWl0RD9gJfGPdtS_RBzLFZYXmO8_tVMRecvEXDvZ860LnpZqIXjZqNHWFvC4PvyqPzSZQXQmi-zzZVnOSpnCM9y9ck4es7moqYWPsa8VOUHEhITlwq9p036XA.jpg

3. Install from folder

If you have downloaded the installation package into a specific folder on your server, you may use this installation option. Enter the file path for that specific folder, then click on the Check and install button. Joomla will automatically try to open the package and run the installation.

XUtG25BQ7QXs__G1PCg-jQUKPASEmLFXgfmp80idsrf1Q5dxURzg4f6B_JvWhCJG-OrYfUrQFhSLgwQoSj0JsPx0DjDovD8CUaHhxfZ0jN8IIhkd3hAONpnZRgKPuJdYwoXxPulX8UCjaxhDXg.jpg

4. Install from URL

Using this option you have to provide Joomla with the direct URL link for the installation package.  Package installation link is: https://raw.github.com/brevo/joomla-plugin/master/build/J3/package/pkg_sendinblue_v1_0_0.zip

After clicking on the Check and install button, Joomla will atomically try to open the package and run installation:

2NHIWemLZbSbohbeIbQLR5M1QW3uo8KHXAA7CTFADlei1Ms4Z2s7_PZuo3252_061G-Y_DsDmpte1RRe5uXiXZlYFX-UYd1Y-8-v9VlGTbMKnjLGVITGf9EvYmTsSIUbe4lnKIo73EyAATBeAA.jpg

Configuring the Brevo component

First, Copy your API v3 key from your Brevo account following this tutorial.

Then go to your Joomla admin, click on Components > Brevo. On the Brevo dashboard, select the API key settings icon.

DE00TQ2iPq9vCm9AAle02k9k3UlDq1AxFHkaTl6qzCwW9iCINx2dHlTV4V6GBjPjFxWzq7nU7OqcCKjwjkHx7PRUMf0Di7vq8VATurcO2aiuWrMd-zdZ40mxHw2vLKzH0lOn5BghedVMqejvmw.jpg

Paste your API v3 key in the box.

joomla_api_key.png

Hit the Save button at the top.  You will then see data from your Brevo account on your Dashboard. If you do not see your data, it is likely that you are not using a valid API key.

joomla_dashboard.png

Setting advanced options

We recommend leaving all advanced options at their default values. If you would like to edit the parameters of the component on a global level, click on the Options button at the top right on your Dashboard.

YXK3PU30q9cJGG052fqXKoV9-gzSVWcbtd8bWKAfHYdF-KDMqJTvhElsrfL1rvXJQrEI1nB3ruwOBSVzY-NEAjX400UDv2eypbiuhTv577XzzxYcgGsDWoC6IunsDDMYBzIC_Saz.png

On this page, you'll be able to edit:

1. Global parameters

  • Base URL - this is the URL used for all API calls. It should be left at the default value.
  • Connection timeout (seconds) - if you have connectivity problems, try increasing this value.

RK5bC3hX7-_LHKwKfsIltm6P6rcpmgiQcwK7PJn2vxnPaHQ1Rp2uipeC3Km6rauhofrmM-gOvQ5L9He7zkergEzxqOfWAedmBpHoccWPKJkK46PeUA-CS06WvFa-ceQ7mtWwuHVb.png

2. Advanced parameters

  • Opt-in template link tag - this is the tag used in Brevo email templates
  • Double opt-in attribute name - the Brevo attribute name which will be used in the confirmation process
  • Opt-in link validity period (minutes) - the length of time a subscriber will have to confirm their subscription
  • Double opt-in temporary folder & double opt-in temporary list - used to temporarily store data about a subscriber until they confirm their subscription

N9_pPriuLrgI6xhHbpdytD7PwsCIgteCziAXghhPs8aGeAr0DLbPLieITGkqn2-Y-K3w3NspbZJQBZrL5l5ih6QxCwZRA3YqEEiw4smqS7Fx04tnkXgpM2v0YXCXHFvugwB0SH6U.png

What's next?:

Have a question?

If you have a question, feel free to create a new issue here.

🤔 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 2 found this helpful