> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Brevo

> How to set up the Brevo connector, plus the actions and events that are available.

![Brevo](https://stackone-logos.com/api/brevo/filled/svg)

v2.3.2[See changelog](https://docs.stackone.com/connectors/brevo/changelog.md)

[70 actions](#actions) · [18 events](#events) · 1 auth method

Marketing
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/brevo/guides/connector-profile/api-key.md)
>
> API key grants full account access with no granular scopes. IP whitelisting available for additional security.

Optionally, configure receiving Events for Brevo into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/brevo/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/brevo/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

70 actions

ActionDescription

List Contacts`brevo_list_contacts`

Retrieve all contacts with pagination and filtering

Get Contact`brevo_get_contact`

Retrieve a specific contact by email or ID

Create Contact`brevo_create_contact`

Create a new contact in Brevo

Update Contact`brevo_update_contact`

Update an existing contact

Delete Contact`brevo_delete_contact`

Delete a contact from Brevo

List Attributes`brevo_list_attributes`

List all contact attributes

List Lists`brevo_list_lists`

Retrieve all contact lists

Get List`brevo_get_list`

Retrieve a specific contact list

Create List`brevo_create_list`

Create a new contact list

Update List`brevo_update_list`

Update an existing contact list

Delete List`brevo_delete_list`

Delete a contact list

List Email Campaigns`brevo_list_email_campaigns`

Retrieve all email campaigns

Get Email Campaign`brevo_get_email_campaign`

Retrieve a specific email campaign with statistics

Create Email Campaign`brevo_create_email_campaign`

Create a new email campaign

Update Email Campaign`brevo_update_email_campaign`

Update an existing email campaign

Delete Email Campaign`brevo_delete_email_campaign`

Delete an email campaign

Returns The Information For All Your Created SMS Campaigns`brevo_list_sms_campaigns`

Returns the information for all your created SMS campaigns

Get An SMS Campaign`brevo_get_sms_campaign`

Retrieve a specific SMS campaign

Create SMS Campaign`brevo_create_sms_campaign`

Create a new SMS campaign

Update SMS Campaign`brevo_update_sms_campaign`

Update an existing SMS campaign

Delete SMS Campaign`brevo_delete_sms_campaign`

Delete an SMS campaign

Send Transactional Email`brevo_send_transactional_email`

Send a transactional email

Get The List Of Email Templates`brevo_list_email_templates`

Retrieve all transactional email templates

Get Email Template`brevo_get_email_template`

Retrieve a specific email template

Create Email Template`brevo_create_email_template`

Create a new transactional email template

Update Email Template`brevo_update_email_template`

Update an existing transactional email template

Delete Email Template`brevo_delete_email_template`

Delete a transactional email template

Create And Send A WhatsApp Campaign`brevo_create_and_send_whatsapp_campaign`

Create and Send a WhatsApp campaign

Return All Your Created WhatsApp Templates`brevo_list_whatsapp_templates`

Return all your created WhatsApp templates

Create A WhatsApp Template`brevo_create_whatsapp_template`

Create a WhatsApp template

Send WhatsApp Message`brevo_send_whatsapp_message`

Send a transactional WhatsApp message

List Deals`brevo_list_deals`

Retrieve all deals with pagination

Get Deal`brevo_get_deal`

Retrieve a specific deal

Create Deal`brevo_create_deal`

Create a new deal in the CRM

Update Deal`brevo_update_deal`

Update an existing deal

List Pipelines`brevo_list_pipelines`

Retrieve all deal pipelines with stages

Get A Pipeline`brevo_get_pipeline`

Retrieve a specific deal pipeline with its stages

Delete Deal`brevo_delete_deal`

Delete a deal from the CRM

List Companies`brevo_list_companies`

Retrieve all companies

Get Company`brevo_get_company`

Retrieve a specific company

Create Company`brevo_create_company`

Create a new company in the CRM

Update Company`brevo_update_company`

Update an existing company

Delete Company`brevo_delete_company`

Delete a company from the CRM

Get All Task Types`brevo_list_task_types`

Retrieve all CRM task types

List Tasks`brevo_list_tasks`

Retrieve all CRM tasks

Get Task`brevo_get_task`

Retrieve a specific CRM task

Create Task`brevo_create_task`

Create a new CRM task

Update Task`brevo_update_task`

Update an existing CRM task

Delete Task`brevo_delete_task`

Delete a CRM task

List Notes`brevo_list_notes`

Retrieve all CRM notes

Get Note`brevo_get_note`

Retrieve a specific CRM note

Create Note`brevo_create_note`

Create a new CRM note

Update Note`brevo_update_note`

Update an existing CRM note

Delete Note`brevo_delete_note`

Delete a CRM note

List Webhooks`brevo_list_webhooks`

Retrieve all webhooks

Get Webhook`brevo_get_webhook`

Retrieve a specific webhook

Create Webhook`brevo_create_webhook`

Create a new webhook

Update Webhook`brevo_update_webhook`

Update an existing webhook

Delete Webhook`brevo_delete_webhook`

Delete a webhook

List Products`brevo_list_products`

Retrieve all products

Get Product`brevo_get_product`

Retrieve a specific product

Create/Update A Product`brevo_create_update_product`

Create or update an eCommerce product

Manage Order Status`brevo_manage_order_status`

Managing the status of the order

Get Email Senders`brevo_list_senders`

Retrieve all validated email senders

Get Account`brevo_get_account`

Retrieve account information

Get Unified Credentials`brevo_unified_get_me`

Get the current Brevo connection's unified credentials and identity.

List Unified Roles`brevo_unified_list_roles`

List unified roles in Brevo.

Get Unified Role`brevo_unified_get_role`

Get a unified Brevo role by ID.

List Unified Users`brevo_unified_list_users`

List unified users in Brevo.

Get Unified User`brevo_unified_get_user`

Get a unified Brevo user by ID.

## Events

Tags

Select all
|
Clear

Marketing Email

Transactional Email

No tags found

18 events

EventDescriptionTags

Email Sent`brevo_webhook_request`

Processes Brevo transactional email send request events.

Transactional Email

Email Delivered`brevo_webhook_delivered`

Processes Brevo email delivery events when an email is successfully delivered.

Transactional EmailMarketing Email

Email Opened`brevo_webhook_opened`

Processes Brevo email open events when a recipient opens an email.

Transactional EmailMarketing Email

Email Unique Opened`brevo_webhook_unique_opened`

Processes Brevo unique open events, fired only on the first open by a recipient.

Transactional Email

Email Clicked`brevo_webhook_click`

Processes Brevo click events when a recipient clicks a tracked link in an email.

Transactional EmailMarketing Email

Email Soft Bounced`brevo_webhook_soft_bounce`

Processes Brevo soft bounce events indicating temporary delivery failure.

Transactional Email

Email Hard Bounced`brevo_webhook_hard_bounce`

Processes Brevo hard bounce events indicating permanent delivery failure.

Transactional Email

Invalid Email`brevo_webhook_invalid_email`

Processes Brevo invalid email events when recipient address is invalid.

Transactional Email

Email Deferred`brevo_webhook_deferred`

Processes Brevo deferred events when email delivery is temporarily delayed.

Transactional Email

Spam Complaint`brevo_webhook_complaint`

Processes Brevo complaint events when a recipient marks an email as spam.

Transactional Email

Email Unsubscribed`brevo_webhook_unsubscribed`

Processes Brevo unsubscribe events when a recipient unsubscribes from emails.

Transactional EmailMarketing Email

Email Blocked`brevo_webhook_blocked`

Processes Brevo blocked events when an email is blocked from delivery.

Transactional Email

Marketing Hard Bounce`brevo_webhook_hard_bounce_marketing`

Processes Brevo marketing campaign hard bounce events.

Marketing Email

Marketing Soft Bounce`brevo_webhook_soft_bounce_marketing`

Processes Brevo marketing campaign soft bounce events.

Marketing Email

Marketing Spam Report`brevo_webhook_spam`

Processes Brevo marketing campaign spam report events.

Marketing Email

Contact Created`brevo_webhook_contact_created`

Processes Brevo contact creation events when a new contact is added to one or more lists.

Marketing Email

Contact Updated`brevo_webhook_contact_updated`

Processes Brevo contact updated events when a contact's information is modified.

Marketing Email

Contact Deleted`brevo_webhook_contact_deleted`

Processes Brevo contact deleted events when a contact is removed.

Marketing Email


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.