This is an internal documentation. There is a good chance you’re looking for something else. See Disclaimer.

Newsletter Brevo Module

Configuration

Brevo_account

  • Create an account on the Brevo website and create an API key for it. At time of writing, this can be done at https://app.brevo.com/settings/keys/api

  • Then, create a Brevo_account entity and use the brevo-credentials action to connect it via the API key from the Brevo account.

  • Finally, copy the auto-generated webhook url and create a webhook in your Brevo account. At time of writing, this can be done at https://my.brevo.com/advanced/webhook

Brevo_folder

Can be used to group lists together.

User_newsletter_category

This is the equivalent to lists in Brevo.

Brevo_attribute

Allows sending more data per contact to Brevo. Paths are validated, so configuring something very wrong is hard, just make sure the datatypes match. Categories can usually be matched to the unique ids of lookup entities.

Synchronisation

BrevoSynchronisationBatchJob synchronises users with related User_newsletter_category every few minutes. Changes in lists and email addresses in Brevo get synced via BrevoWebhook. Additionally, changes to email addresses, Brevo_attribute or removals specifically of User_newsletter_category from users get synchronised to via listeners to Brevo.