Brevo

Learn how to use the Brevo provider to send email notifications using Novu

You can use the Brevo provider to send transactional emails to your customers using the Novu Platform with a single API.

Getting Started

To use the Brevo provider in the email channel, you will need to create a Brevo account and add your API key to the Brevo integration on the Novu platform.

Finding the API Key

• To find your Brevo API key, log into your Brevo account and navigate to the API Keys page.

Authenticating your sender identity

Before you can send emails on a large scale, you will need to authenticate your sender’s identity. This is due to the latest regulatory changes regarding SPAM rules and email fraud. Most of the providers including Brevo require you to authenticate your sender identity before you can send emails.

Brevo allows you to authenticate your sender identity using one of the following methods:

• Single Sender Verification - This is the easiest way to authenticate your sender identity.
• Entire Domain Authentication - This is recommended if you are sending emails from multiple accounts under your domain.

Creating a Brevo integration with Novu

• Visit the Integrations store on the Novu web dashboard.
• Click on Add a Provider.
• Select Brevo service.
• Enter your Brevo API key.
• Fill in the From email address field using the authenticated email from the previous step.
• Click on the Disabled button and mark it as Active.
• Click on the Update button.
• You should now be able to send notifications using Brevo in Novu.

Using Brevo template

Novu has its own email editor for writing email template. If you want to use pre made template from Brevo, you can use customData filed of email overrides to send template details. Make sure your Api Key has enough permission to read and process the template.

customData override is available from version 0.21.0

• Node.js
• cURL

import { Novu } from '@novu/node';

const novu = new Novu('<NOVU_SECRET_KEY>');

await novu.subscribers.trigger("workflowIdentifier", {
to: "subscriberId",
payload: {},
overrides: {
email: {
customData: {
// sendinblue template templateId
templateId: 1,
// sendinblue template variables
templateParams: {
total: '$ 239.85',
items: [{
text: 'New Line Sneakers',
image: 'https://marketing-image-production.s3.amazonaws.com/uploads/8dda1131320a6d978b515cc04ed479df259a458d5d45d58b6b381cae0bf9588113e80ef912f69e8c4cc1ef1a0297e8eefdb7b270064cc046b79a44e21b811802.png',
price: '$ 79.95',
},
{
text: 'Old Line Sneakers rlfjrjrh4hr4rh4',
image: 'https://marketing-image-production.s3.amazonaws.com/uploads/3629f54390ead663d4eb7c53702e492de63299d7c5f7239efdc693b09b9b28c82c924225dcd8dcb65732d5ca7b7b753c5f17e056405bbd4596e4e63a96ae5018.png',
price: '$ 79.95',
},
],
receipt: true,
name: 'Sample Name',
address01: '1234 Fake St.',
address02: 'Apt. 123',
city: 'Place',
state: 'CO',
zip: '80202',
},
},
}
},
// actorId is subscriberId of actor
actor: "actorId",
tenant: "tenantIdentifier"
});