Skip to main content

Authorization

Follow this guide to create a new Brevo credential that will allow Nexla to authenticate to and exchange data with your Brevo account.
brevo_api_auth.png

Brevo

Prerequisites​

Before creating a Brevo credential in Nexla, you must have an active Brevo account and generate an API key from the Brevo dashboard. Brevo uses API key authentication for all v3 API requests, with the key passed in the api-key HTTP header.

Create a Brevo Account​

An active Brevo account is required to generate API credentials. New accounts can be created at brevo.com by signing up with an email address. Brevo offers a free tier that supports API access, making it easy to begin testing integrations before scaling to paid plans.

Generate a Brevo API Key​

Brevo v3 API keys are managed from the SMTP & API settings page in the Brevo dashboard. To generate a new API key, complete the following steps:

  1. Log in to your Brevo account at app.brevo.com.

  2. Click your account name in the upper-right corner of the dashboard, and select Settings from the dropdown menu.

  3. In the left navigation pane, click SMTP & API.

  4. Select the API Keys tab.

  5. Click the Generate a new API key button to open the key creation dialog.

  6. Enter a descriptive name for the new API key in the Name your API key field (e.g., "Nexla Integration"). Using a clear, purpose-specific name makes it easier to identify and rotate keys later.

  7. Optionally, select an expiration period for the key from the Expiration dropdown. Brevo supports expirations from 7 days up to 1 year, or no expiration. Setting an expiration is recommended for production environments to limit the impact of a leaked key.

  8. Click Generate to create the API key.

  9. Copy the generated API key from the dialog and store it in a secure location, such as a password manager or secrets vault.

    Important

    The full API key value is shown only once at the time of generation. Brevo will not display the key again after the dialog is closed. If the key is lost, a new key must be generated.

For additional details about Brevo's authentication scheme, refer to the Brevo API key authentication documentation.

Brevo v3 API keys provide full access to your Brevo account. Treat API keys like passwords—never commit them to source control, share them via email, or expose them in client-side code.

Create a Brevo Credential​

  • To create a new Brevo credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Brevo Authentication Settings​

Brevo uses API key authentication. The API key generated from the Brevo dashboard is used to authenticate all requests sent from Nexla to the Brevo v3 API.

  1. Enter the Brevo API key generated from your Brevo account in the API Key field. This key is used to authenticate Nexla with your Brevo account and is included in the api-key HTTP header of every API request.

    The API key is stored securely in Nexla and is never displayed after the credential is saved. To rotate the key, generate a new API key in Brevo, update the credential in Nexla, and then revoke the old key from the Brevo dashboard.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.