Brevo

Capability: Notifications

Market: US, UK, CEE

Transactional and campaign emails with unsubscribe features.

Environments

UAT: https://dci-uat.ondisplayftos.com

PROD: https://dci.fintechos.com

Exposed Endpoints

SendMessage

https://<env>/dcs/message2/sendMessage

Can send a list of emails.

 

 

SendMarketingMessage

https://<env>/dcs/message2/sendMarketingMessage

This endpoint should be used by customers who send mass marketing emails, to be compliant with ‘One-Click List-Unsubscribe Header – RFC 8058’ and is the same as SendMessage (same request and same response) but handles specific email headers needed for compliance. Sending mass marketing emails using the standard SendMessage endpoint can result in emails being flagged as spam, blocked by the majority of inbox providers, degraded reputation for the Brevo account and ultimately blacklisted (unable to send any more emails).

Brevo Emails

There are multiple use cases through which Brevo can be hooked up to the platform. For the emails to be sent out properly by the provider (Brevo Emails), the FintechOS support rep handling your access ticket will require you to authenticate your domain with Brevo, so that the emails sent out are verified (3 CNAME records must be added in your DNS provider for DKIM and SPF verification).

Sending Transactional Emails

Follow the steps below to send transactional emails using the connector, with delivery receipts and tracking via MessageQueue:

1. Submit a ticket to Support, requesting access to Brevo Emails with webhooks.

2. In Studio, go to Menu > Admin > Omnichannel Communication Automation > Channel Providers.

3. Select FTOSEmailGateway.

   

4. Fill in:

   • Brevo SendMessage endpoint => Service Url field

   • Subscription Key received in the Service Access Ticket => App Key field

   • Your from address in the From field (default sending address).

5. Add your message in the message queue with the configured channel provider by using the email Server SDK functions described here Server SDK Reference Guide and specify the channel provider parameter as “FTOSEmailGateway”.

You can work with a secondary / backup provider or even a custom channel configuration (create your own channel provider with the settings you need). However, when doing so, you will also need to add the handling of this channel provider in the JobServer PlatformServices Vault Settings → Services config and Triggers config (FTOSEmailGateway is already configured and is handled by the JobServer out-of-the-box).

The entity FTOS_DPA_MessageQueue is where the messages are stored (to be sent by the JobServer). By using Brevo SendMessage, the delivery receipts and tracking events will arrive back at the platform and will be stored in the entity FTOS_DPA_MessageEvent correlated by the FTOS_DPA_MessageQueueId column.

Sending Marketing Emails via the connector

1. Submit a ticket to Support, requesting access to Brevo Emails with or without webhooks (if you want tracking or not. keep in mind, marketing emails usually means around 50000 emails in 24h, and their tracking events can generate a lot of spam inbound as 1 email usually translates to 2-5 tracking events returned to the platform. this could result in high resource consumption when the events are ingested by the platform).

2. In Studio, go to Menu > Admin > Omnichannel Communication Automation > Channel Providers.

3. Select FTOSEmailGateway or create your own custom marketing channel provider.

4. Fill in:

   • Brevo SendMarketingMessage → Service Url

   • Subscription Key received in the Service Access Ticket => App Key field

   • Your from address in the From field (default sending address)

   • Configure the Bulk processing for the channel provider (send 100/1000 emails at once)

5. Add your marketing emails to the MessageQueue using your desired custom service/script and using your desired email template (ftos.messaging.send ).

If you are using a custom marketing channel provider, be sure to add it to Vault JobServer-PlatformServices Services config and Triggers Config so that the JobServer can expedite them.

Sending Transactional Emails

Follow the steps below to send transactional emails using Brevo SMTP (fire-and-forget, no delivery receipts, straight to provider, skipping the connector):

1. Create a ticket to Support, requesting access to Brevo Emails using SMTP.

2. In Studio, go to Menu > Admin > Omnichannel Communication Automation > Channel Providers and create a new channel provider.

   

   • Provider Name: smtp, and give it a name (ex: SmtpEmail)

   • Service Url: the provider smtp address and port. ex: smtp-relay.provider.com:587

   • App User: the smtp user (defined in the provider account, will be provided in the ticket response)

   • App Key: the smtp key (defined in the provider account, will be provided in the ticket response)

3. Go to Vault settings → JobServer-PlatformServices and add the smtp channel provider to the Services config (add this json config object in the Services configuration list).

   Copy

   {
       "execParams": "provider=smtp;providerSetting=SmtpEmail",
       "Assembly": "FintechOS.Jobs.MessageDelivery.ScheduledServices",
       "Class": "FintechOS.Jobs.MessageDelivery.ScheduledServices.SendMessagesService",
       "Method": "",
       "Name": "FTOS.SendMessagesServiceSmtp",
       "SendNotification": null,
       "Type": "class"
     }

4. Also here, modify the Triggers config to add the scheduler for handling the smtp channel provider (add this json config object in the Triggers configuration list).

   Copy

   {
       "Async": false,
       "Calendar": null,
       "EndTime": "03.11.2080 11:02",
       "Expression": "0/30 * * * * ?",
       "Name": "FTOS.SendMessagesServiceSmtp",
       "PoolTime": null,
       "RepeatCount": "-1",
       "RescheduleAfterRun": false,
       "Services": [
         "FTOS.SendMessagesServiceSmtp"
       ],
       "StartTime": "02.11.2020 11:00"
   }

5. Restart JobServer-PlatformServices so it can load the newly configured settings.

6. Add your message in the message queue using the configured channel provider by using the the email server sdk functions described here Server SDK Reference Guide and specify the channel provider parameter as your defined smtp channel provider (ex: SmtpEmail as seen in the above channel provider configuration screen).