Brevo Data Source

The Brevo connector enables you to ingest contacts, contact lists, segments, companies, email and SMS campaigns, transactional email events, email templates, and account-level data from your Brevo account into Nexla. Follow the instructions below to create a new data flow that ingests data from a Brevo source in Nexla.

Brevo

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

2. Select the Brevo connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Brevo instance, and click Next; or, create a new Brevo credential for use in this flow.

3. In Nexla, Brevo data sources can be created using pre-built endpoint templates, which expedite source setup for common Brevo endpoints. Each template is designed specifically for the corresponding Brevo endpoint, making source configuration easy and efficient.
   • To configure this source using a template, follow the instructions in Configure Using a Template.

   Brevo sources can also be configured manually, allowing you to ingest data from Brevo endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Brevo endpoints. Each template is designed specifically for the corresponding Brevo endpoint, making data source setup easy and efficient.

Endpoint Settings

• Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

  Get Account Information

  Retrieves account details and plan statistics for the authenticated Brevo user, including company name, address, plan type, and remaining email/SMS credits. Use this endpoint to monitor account usage, verify connection health, or surface account metadata in downstream systems.

  • This endpoint requires no additional parameters. Selecting this template configures the source to call GET https://api.brevo.com/v3/account and return the full account object as a single record.

  For complete response field definitions, refer to the Get account information documentation.

  Get a contact's details

  Retrieves detailed information about a specific contact, including all attributes, list memberships, and activity statistics. Use this endpoint when you need to fetch a single contact record for enrichment, sync, or audit purposes.

  • Enter the contact's identifier in the Identifier field. This can be an email address, contact ID, ext_id, or phone number depending on the identifier type selected.
  • Optionally, specify the type of identifier used in the Identifier Type field. Supported values include email_id (default), contact_id, ext_id, phone_id, whatsapp_id, landline_number_id, and sms_id. Use this when the identifier is not an email address.
  • Optionally, enter a Start Date in YYYY-MM-DD format to filter contact activity statistics starting from a specific date.
  • Optionally, enter an End Date in YYYY-MM-DD format to filter contact activity statistics up to a specific date.

  The start and end date filters apply only to the contact's activity statistics block in the response, not to the contact record itself. For full parameter documentation, refer to the Get a contact's details reference.

  Get all the contacts

  Retrieves all contacts in your Brevo account, with support for filtering by date, list, segment, and contact ID. This endpoint uses offset-based pagination (default page size 1000) and is the primary way to perform full or incremental contact syncs from Brevo to a downstream system.

  • Optionally, enter an ISO 8601 datetime in the Modifiedsince field to retrieve only contacts modified on or after the specified date. This is useful for incremental ingestion scenarios.
  • Optionally, enter an ISO 8601 datetime in the Createdsince field to retrieve only contacts created on or after the specified date.
  • Optionally, specify a sort order in the Sort field. Accepted values are asc or desc; results are sorted by contact creation date.
  • Optionally, enter a comma-separated list of contact IDs in the Ids field to limit results to specific contacts.
  • Optionally, enter a segment ID in the Segmentid field to retrieve only contacts belonging to that segment.
  • Optionally, enter a comma-separated list of list IDs in the Listids field to retrieve only contacts belonging to those lists.
  • Optionally, enter a JSON filter expression in the Filter field to apply additional filtering on contact attributes.

  Pagination is handled automatically by Nexla using the limit and offset query parameters. For complete documentation, refer to the Get all the contacts reference.

  Get scheduled email status

  Retrieves the delivery status and batch details for scheduled transactional emails. Use this endpoint to track the lifecycle of scheduled email batches or individual messages by batch ID or message ID.

  • Enter the batch ID or message ID in the Identifier field. This is the value returned by the Send a transactional email endpoint when scheduling messages.
  • Optionally, enter an ISO 8601 datetime in the Start date field to filter scheduled emails on or after the specified date.
  • Optionally, enter an ISO 8601 datetime in the End date field to filter scheduled emails on or before the specified date.
  • Optionally, specify a sort order (asc or desc) in the Sort order field.
  • Optionally, filter by delivery state in the Email status field. Common values include processed, queued, sent, bounced, and error.

  For complete parameter and response details, refer to the Get scheduled email status reference.

  Get an email template

  Retrieves the full configuration and HTML content of a specific transactional email template by ID. Use this endpoint to back up templates, audit template content, or replicate templates across Brevo accounts.

  • Enter the numeric template ID in the Template ID field. Template IDs are visible in the Brevo dashboard under Transactional > Templates and are also returned by the List email templates endpoint.

  For complete response details, refer to the Get an email template reference.

  List Companies

  Retrieves a paginated list of all companies in the Brevo CRM. Companies in Brevo represent organizations associated with contacts and deals and are central to B2B marketing and sales workflows.

  • This endpoint requires no additional parameters. Pagination is handled automatically by Nexla using the limit and offset query parameters (default page size 50).

  For complete documentation, refer to the Get all companies reference.

  List Contact Attributes

  Retrieves the complete list of contact attributes defined in your Brevo account, including normal attributes, transactional attributes, category attributes, calculated values, and global values. Use this endpoint to inspect or document your contact schema before designing flows.

  • This endpoint requires no additional parameters. The full attribute definition list is returned as a single response and parsed into individual records.

  For complete documentation, refer to the List all attributes reference.

  List Contact Lists

  Retrieves a paginated list of all contact lists in your Brevo account, including list name, folder ID, and total/unique subscriber counts. Use this endpoint to enumerate available lists for sync, audit, or downstream segmentation logic.

  • This endpoint requires no additional parameters. Pagination is handled automatically by Nexla using the limit and offset query parameters (default page size 50).

  For complete documentation, refer to the Get all lists reference.

  List Contact Segments

  Retrieves all dynamic contact segments defined in your Brevo account. Segments are saved filter expressions used to target contacts in campaigns and automation workflows.

  • This endpoint requires no additional parameters. Pagination is handled automatically by Nexla using the limit and offset query parameters (default page size 50).

  For complete documentation, refer to the Get all segments reference.

  List Email Campaigns

  Retrieves all email campaigns in the account, including draft, scheduled, sent, and archived campaigns. Use this endpoint to track campaign inventory, monitor campaign performance metadata, or sync campaign records to a data warehouse for reporting.

  • This endpoint requires no additional parameters. The full campaign list is returned and parsed into individual records.

  For complete documentation, refer to the Get all email campaigns reference.

  List email templates

  Retrieves a paginated list of transactional email templates, with optional filtering by active/inactive status. Use this endpoint to audit your transactional template library or to drive downstream template management flows.

  • Optionally, filter templates by activation state in the Template status field. Use true to return only active templates or false to return only inactive templates. Omit this parameter to return all templates.
  • Optionally, specify a sort order (asc or desc) for the result set in the Sort order field. Results are sorted by template creation date.

  For complete documentation, refer to the Get the list of transactional email templates reference.

  List members of a contact list

  Retrieves all contacts belonging to a specific contact list. Use this endpoint to extract list memberships for segmentation, deduplication, or sync to external CRMs.

  • Enter the numeric list ID in the List ID field. List IDs can be obtained from the List Contact Lists endpoint or from the Brevo dashboard under Contacts > Lists.

  Pagination is handled automatically by Nexla using the limit and offset query parameters (default page size 500). For complete documentation, refer to the Get contacts in a list reference.

  List Senders

  Retrieves all configured email senders for your Brevo account, including sender name, email address, and verification status. Senders must be verified before they can be used in email campaigns or transactional emails.

  • This endpoint requires no additional parameters. The full sender list is returned as records.

  For complete documentation, refer to the Get the list of all your senders reference.

  List SMS Campaigns

  Retrieves all SMS campaigns in the account, including draft, scheduled, and sent campaigns. Use this endpoint to monitor SMS marketing activity or sync campaign records to a reporting database.

  • This endpoint requires no additional parameters. The full SMS campaign list is returned as records.

  For complete documentation, refer to the Get all the SMS campaigns reference.

  List transactional emails

  Retrieves a paginated event log of transactional emails sent through your Brevo account, with filtering by recipient, template, message ID, and date range. Use this endpoint to build delivery analytics, troubleshoot send failures, or feed transactional email events into an observability pipeline.

  • Optionally, enter a recipient email address in the Recipient email field to filter the log to messages sent to a specific recipient.
  • Optionally, enter a template ID in the Template ID field to filter messages sent using a specific transactional template.
  • Optionally, enter a message ID in the Message ID field to retrieve a single message event.
  • Optionally, enter an ISO 8601 datetime in the Start date field to filter events on or after the specified date.
  • Optionally, enter an ISO 8601 datetime in the End date field to filter events on or before the specified date.
  • Optionally, specify a sort order (asc or desc) in the Sort order field.

  Pagination is handled automatically by Nexla using the limit and offset query parameters (default page size 500). For complete documentation, refer to the Get all transactional emails reference.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Brevo data sources can be manually configured to ingest data from any valid Brevo API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates—such as conversation, deal, task, or webhook endpoints—or for cases where custom query parameters, headers, or paging behaviors are needed.

With manual configuration, you can also create more complex Brevo sources, such as sources that use chained API calls to fetch data from multiple endpoints (e.g., listing lists and then fetching members for each list) or sources that require custom request parameters.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the Brevo API from the Method pulldown menu. The most common methods are:

   • GET: For retrieving data from the API. This is the most common method for Brevo source endpoints.
   • POST: Used by some Brevo search and reporting endpoints that accept a JSON body.

API Endpoint URL

3. Enter the URL of the Brevo API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. All Brevo v3 endpoints are hosted at https://api.brevo.com/v3/—for example, https://api.brevo.com/v3/contacts or https://api.brevo.com/v3/emailCampaigns/{campaignId}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods. This is particularly useful for Brevo endpoints that accept startDate and endDate filters, such as the transactional email event log or scheduled email status endpoints.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime
   • {now-1} – The datetime one time unit before the current datetime
   • {now+1} – The datetime one time unit after the current datetime
   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. Brevo endpoints generally expect ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) or simple date (yyyy-MM-dd) formats. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data. For Brevo, this is useful when iterating over contact IDs, list IDs, or campaign IDs sourced from another flow.

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs, values, or parameters from other data sources in your Nexla environment.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data returned by the Brevo endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly important for Brevo because most list endpoints wrap records inside a named array (e.g., contacts, lists, campaigns, segments, templates, transactionalEmails).

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.contacts[*] for the GET /contacts endpoint, or $.lists[*] for the GET /contacts/lists endpoint).
  Path to Data Examples for Brevo:

  • $.contacts[*] — for GET /v3/contacts
  • $.lists[*] — for GET /v3/contacts/lists
  • $.campaigns[*] — for GET /v3/emailCampaigns and GET /v3/smsCampaigns
  • $.templates[*] — for GET /v3/smtp/templates
  • $.transactionalEmails[*] — for GET /v3/smtp/emails
  • $.attributes[*] — for GET /v3/contacts/attributes

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. For Brevo list endpoints, this is useful for preserving the top-level count field, which indicates the total number of records available across all pages.

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata (e.g., $.count for total record counts).

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

  You do not need to include the api-key header here—it is automatically injected from the credential. Common headers like Accept and Content-Type are also handled automatically by Nexla.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Brevo data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.