Page Builder Summit Limited Time Offer - 20% OFF! Use coupon PBS20 - View Details

BrevoPRO

This knowledge base article relates to the WS Form Brevo add-on. Included with the Agency edition or buy separately for other editions.

This add-on lets you subscribe and unsubscribe Brevo contacts using a WordPress form created in WS Form. You can create new forms from your Brevo lists in a single click from the add form page. You can also pre-populate forms with data from Brevo.

Brevo was formerly Sendinblue.

Installation

The Brevo plugin is installed in the same way as installing the WS Form PRO plugin.

Once installed you will need to activate the license for the plugin. When you purchase the Brevo plugin, you will be given a license key. If you have lost your license key(s), click here.

To activate your license key:

  1. Click WS Form in the WordPress administration menu.
  2. Click Settings.
  3. Click the Brevo tab at the top of the page.
  4. Enter your license key.
  5. Click the Activate button.

If your license key fails to activate, please ensure you are using the correct license key and not your WS Form PRO license key.

Connecting to Brevo

In order to use the add-on, you need to connect it to Brevo. Connecting is easy!

  1. Click WS Form in the WordPress administration menu.
  2. Click Settings.
  3. Click the Brevo tab at the top of the page.
  4. Enter your API key from the Brevo SMTP and API page. Ensure you are using a version 3 key.WS Form - Brevo Add-On - API Key
  5. Click Save.

If you do not have a Brevo account, you can create a new account here.

Creating a Form for Brevo

Automatically

WS Form can create a form for any of your Brevo objects in a single click. This process not only creates a form but also fully configures WS Form so that the form is ready to use immediately.

To create a Brevo form in WS Form:

  1. Click WS Form in the WordPress administration menu.
  2. Click Add New.
  3. Select the Brevo tab at the top of the page.
  4. Click on a list.
  5. Wait a few moments while the form is created.

That’s it! Your form will be created and is ready to add to your website.

If your list does not appear, click the refresh icon in the Brevo tab.

Manually

It is also possible to use any form created in WS Form and add an action so that it is submitted to a Brevo object when a user saves or submits their form.

To add a Brevo action:

  1. When editing your form, click the Actions icon at the top of the page. The Actions sidebar will open on the right-hand side of the page.
  2. Click the Add  icon to add a new action.
  3. Select Add to Brevo from the Action pulldown. A series of settings will appear.

As with all sidebars in WS Form, click to the Save button at the bottom to save your changes, or click Cancel to disregard your changes.

The Brevo action settings are as follows:

When Should This Action Run?

You can choose to run the Brevo action when the form is saved, submitted, or both.

Brevo List

Select which list the contact should be subscribed to.

Status

You can choose to subscribe or unsubscribe a contact. For GDPR compliance you can also choose the Subscribe with Double Opt-In status. This method requires you to set-up a double opt-in template in Brevo.

If you are subscribing a contact, the email address or SMS attribute must be mapped and completed.

If you are unsubscribing a contact, the email address must be mapped and completed.

Enable Update (Subscribe Status Only)

If checked, the contact will be updated if a matching contact is already found.

Double Opt-In Template ID (Subscribe with Double Opt-In Status Only)

If you have chosen the Subscribe with Double Opt-In status, you will need to specify the template ID of a double opt-in template.

You can learn more about creating a double opt-in template in Brevo here.

The template ID is a number. For example, in the screenshot below, the template ID would be: 1

WS Form - Brevo Add-On - Template ID

Double Opt-In Redirect URL (Subscribe with Double Opt-In Status Only)

If you have chosen the Subscribe with Double Opt-In status, you will need to specify the redirect URL that a user will be sent to after they have clicked the double opt-in link. This would typically be an absolute URL to a page on your website.

For example: https://mywebsite.com/double-opt-in-thank-you/

Opt-In Field

Use this setting to select which of your fields to act as the opt-in field. We recommend adding a checkbox field with a single checkbox. It is always recommended that you have an unchecked opt-in checkbox on your forms to ensure you comply with GDPR requirements.

When the users opts-in, WS Form will set the custom attribute OPT_IN to True.

Field Mapping

Field mapping tells WS Form which of your form fields relates to the corresponding attributes in Brevo. For example you would want to map your email form field to the email attribute in Brevo. WS Form supports mapping to normal, category and transactional attributes.

To map a field:

  1. Click the Add  icon at the bottom right of the field mapping section.
  2. In the left-hand column, select your form field.
  3. In the right-hand column, select the corresponding Brevo attribute.
  4. Repeat this process for each field on your form.
  5. Click the Save button at the bottom of the sidebar to save your changes.
If you are mapping a phone field, we recommend enabling the International Phone Input setting and setting the Return Format setting to E164. Otherwise the format should be: +15551234567
Custom Mapping

Custom mapping allows you to set a Brevo field to any value you wish, including the use of WS Form variables. For example you might want to map a lead source to a source attribute in Brevo, or perhaps set a transaction attribute ID to the #submit_id variable.

To add a custom mapping:

  1. Click the Add  icon at the bottom right of the field mapping section.
  2. In the left-hand column, enter a value or a WS Form variable.
  3. In the right-hand column, select the corresponding Brevo attribute.
  4. Repeat this process for each field on your form.
  5. Click the Save button at the bottom of the sidebar to save your changes.

Populate Forms Using Brevo

As well as pushing form data with this add-on, you can also retrieve contact data and populate the fields on your form.

This feature is only available if a website visitor is signed in and their WordPress email address matches the email address of a contact in Brevo.

To enable this feature:

  1. Click the Form Settings icon in the top toolbar when editing a form.
  2. Click the Data tab in the sidebar.
  3. Enable the Populate Using Action setting.
  4. Choose Brevo from the Action To Populate From pull-down menu.
  5. Select the list you wish to populate data from in the List To Populate From pull-down menu.
  6. Map the Brevo attribute to your form fields.
  7. Click Save at the bottom.

Note that if you created your form using a Brevo template the field mappings will automatically be created for you.