Brevo Setup Guide
Prerequisites: You will need to have your own Brevo Transactional email subscription account. https://www.brevo.com/pricing/#
Step 1: You will need to generate an API key that you will need to give to us via the support ticket system, so we can add it to your site settings.
Login to Brevo, using this link and you will see the following login page.
Generate the API key by clicking on your name (top right hand side of the screen) and select “SMTP & API”
You will see two tabs “SMTP” and “API Keys”.
Click on “API Keys” then click on “Generate a new API Key”
Give the API Key a name - it can be anything you want.
Click “Generate”
At this point the you will need to copy the API Key and send it over to us.
Once you have done this, and we have informed you that we have added the API key, move on to step 2.
Step 2: Create a Webhook
To create a webhook the you will need to log into your Brevo account.
Click on “Transactional” >> “Settings”
Click on “Webhook”
Then click on the “Add new webhook” button (Top middle of the screen, next to the URL search field)
Add the URL of of your CRM site for example
https://finova.ekeeperonline.co.uk
Please note that in order for the status updates to come back into the CRM you will need to add the following to the tail end of the CRM URL.
/api/v1/brevo/update_status
https://finova.ekeeperonline.co.uk/api/v1/brevo/update_status
Select all the statuses that will apply to this Webhook, so if you want to know when your client has opened the email or unsubscribed then you will select “First Opening” and “Unsubscribed”
Click “Save”
Step 4: Setting up the email address. (Brevo uses the Central email account details)
From the CRM, navigate to System Settings >> Central Email Account Details.
Click on “Connect Brevo Account”
You wont need to add any port numbers or SMTP server details here. All you need to do is add a Default sender name. i.e. 5X Mortgages LTD.
In the Default sender address you will need to add a valid email address. Click “Test Connection & Save”
Step 5: (Optional) Sending your first email making sure its all working as intended.
To send out an email you can do it in the usual way. You need to make sure that you add a Brevo tag to the email otherwise it will not show in Brevo and it will not send back the statuses into the CRM.
You will see a text field on the create email page
The Brevo tag can be anything you want so you can see which emails you have sent. e.g. to send out marketing emails you could name the tag something like “MarketingOct2023”
Make sure you choose the “Central Email Account” in the “From” dropdown.
Click Send.
If you scroll down to the Document History panel on the product, you will see that the email has been delivered according to the Status column.
Check Brevo
Under the Transactional section on Brevo. Click on Log. You can enter filters to for this demo I am going to choose the Brevo tag I added to the email “MarketingOct2023”
I added a link on my email which, when clicked will go to finova.tech and as you can see from the events that link was clicked.
you can also see this from the product on the CRM by going down to the Document History Panel.
As you can see, that link was clicked.