Overview
Pre-built tooling
Pre-built integrations
Access requirements
Setup guide
Useful links
API gotchas
Pre-built tooling
✅ Authorization
✅ Authorization
| Tools | Status |
|---|---|
| Pre-built authorization (API Key) | ✅ |
| Pre-built authorization UI | ✅ |
| Custom authorization UI | ✅ |
| End-user authorization guide | 🚫 |
| Expired credentials detection | ✅ |
✅ Read & write data
✅ Read & write data
| Tools | Status |
|---|---|
| Pre-built integrations | ✅ |
| API unification | ✅ |
| 2-way sync | ✅ |
| Webhooks from Nango on data modifications | ✅ |
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: <48h) |
| Proxy requests | ✅ |
✅ Observability & data quality
✅ Observability & data quality
| Tools | Status |
|---|---|
| HTTP request logging | ✅ |
| End-to-end type safety | ✅ |
| Data runtime validation | ✅ |
| OpenTelemetry export | ✅ |
| Slack alerts on errors | ✅ |
| Integration status API | ✅ |
✅ Customization
✅ Customization
| Tools | Status |
|---|---|
| Create or customize use-cases | ✅ |
| Pre-configured pagination | 🚫 (time to contribute: <48h) |
| Pre-configured rate-limit handling | 🚫 (time to contribute: <48h) |
| Per-customer configurations | ✅ |
Others
| Function name | Description | Type | Source code |
|---|---|---|---|
add-contacts-to-list | Bulk-add one or more existing contacts, identified by email, to a Brevo contact list. | Action | 🔗 Github |
create-company | Create a new company (CRM object). | Action | 🔗 Github |
create-contact-attribute | Define a new custom contact attribute (field) on the account contact schema. | Action | 🔗 Github |
create-contact-folder | Create a new contact folder to organize contact lists | Action | 🔗 Github |
create-contact-list | Create a new contact list inside a folder. | Action | 🔗 Github |
create-contact | Create a new contact | Action | 🔗 Github |
create-deal | Create a new deal. | Action | 🔗 Github |
create-email-campaign | Create a draft email (classic) campaign | Action | 🔗 Github |
create-email-template | Create a new transactional email template | Action | 🔗 Github |
create-sms-campaign | Create a draft SMS campaign. | Action | 🔗 Github |
delete-company | Delete a company. | Action | 🔗 Github |
delete-contact-attribute | Permanently delete a custom contact attribute from the account schema by category and name. | Action | 🔗 Github |
delete-contact-folder | Delete a contact folder and all contact lists it contains. | Action | 🔗 Github |
delete-contact-list | Delete a contact list. | Action | 🔗 Github |
delete-contact | Delete a contact | Action | 🔗 Github |
delete-deal | Delete a deal | Action | 🔗 Github |
delete-email-campaign | Delete an email campaign. | Action | 🔗 Github |
delete-email-template | Permanently delete an inactive transactional email template by its numeric ID. | Action | 🔗 Github |
delete-sms-campaign | Delete an SMS campaign. | Action | 🔗 Github |
get-company | Retrieve a single company by ID. | Action | 🔗 Github |
get-contact-folder | Retrieve a single contact folder’s details by ID. | Action | 🔗 Github |
get-contact-full-profile | Get a 360-degree view of a contact: the contact record, its linked CRM companies and its linked CRM deals in one call. | Action | 🔗 Github |
get-contact-list | Retrieve the details of a single Brevo contact list by its ID | Action | 🔗 Github |
get-contact | Retrieve a single contact by email or numeric ID. | Action | 🔗 Github |
get-deal | Retrieve a single deal by ID | Action | 🔗 Github |
get-email-campaign | Retrieve a single email campaign’s full detail, including delivery statistics | Action | 🔗 Github |
get-email-template | Retrieve a single transactional email template’s detail. | Action | 🔗 Github |
get-sms-campaign | Retrieve a single SMS campaign by ID, including its content, recipients, status, and delivery statistics. | Action | 🔗 Github |
get-transactional-email-events | Retrieve the transactional email event log (requests, delivered, opens, clicks, bounces, etc.) for the account. | Action | 🔗 Github |
link-unlink-company-contacts | Link or unlink contacts and/or deals to a company in a single request. | Action | 🔗 Github |
link-unlink-deal-relations | Link or unlink contacts and/or companies to a deal. | Action | 🔗 Github |
list-companies | List companies (Brevo CRM company objects) with pagination, sorting, and optional filters. | Action | 🔗 Github |
list-company-attributes | List the schema of attributes available on company (CRM) objects. | Action | 🔗 Github |
list-contact-attributes | List the account’s contact attribute schema (built-in and custom fields such as FIRSTNAME/LASTNAME). | Action | 🔗 Github |
list-contact-folders | List the account’s contact folders (the organizational containers for lists) | Action | 🔗 Github |
list-contact-lists | List the contact lists in the Brevo account | Action | 🔗 Github |
list-contacts-in-list | List the contacts that belong to a specific contact list | Action | 🔗 Github |
list-contacts | List contacts in the account. | Action | 🔗 Github |
list-deal-pipelines | List the account’s CRM deal pipelines and their stages. | Action | 🔗 Github |
list-deals | List deals (Brevo’s lightweight CRM deal/opportunity objects). | Action | 🔗 Github |
list-email-campaigns | List email (classic) campaigns in the account. | Action | 🔗 Github |
list-email-templates | List the account’s transactional email templates. | Action | 🔗 Github |
list-senders | List the account’s verified sender email addresses. | Action | 🔗 Github |
list-sms-campaigns | List SMS campaigns in the account, with optional status filtering, sorting and pagination. | Action | 🔗 Github |
remove-contacts-from-list | Remove one or more contacts, identified by email, from a Brevo contact list. | Action | 🔗 Github |
schedule-email-campaign | Schedule a draft email campaign to send at a future date/time. | Action | 🔗 Github |
send-email-campaign-now | Send an existing draft email campaign immediately. | Action | 🔗 Github |
send-immediate-campaign | Create a classic email campaign and send it immediately to the given contact lists in one call. | Action | 🔗 Github |
send-transactional-email | Send a one-off transactional email, either with inline HTML or by rendering a saved template with params. | Action | 🔗 Github |
subscribe-contact-to-list | Subscribe an email address to a Brevo contact list, creating the contact if it is new or merging onto the existing contact if it already exists. | Action | 🔗 Github |
unsubscribe-contact-from-list | Unsubscribe a contact from a list: removes a single contact, identified by email, from a single list while leaving all other list memberships untouched | Action | 🔗 Github |
update-company | Update a company’s attributes. | Action | 🔗 Github |
update-contact-folder | Rename a contact folder. | Action | 🔗 Github |
update-contact-list | Rename a contact list or move it to a different folder. | Action | 🔗 Github |
update-contact | Update a contact’s attributes, list memberships, or blacklist status (partial merge). | Action | 🔗 Github |
update-deal | Update a deal’s attributes (name, amount, custom fields). | Action | 🔗 Github |
update-email-campaign | Update a draft or not-yet-sent email campaign. | Action | 🔗 Github |
update-email-template | Update a transactional email template in Brevo | Action | 🔗 Github |
update-sms-campaign | Update a draft SMS campaign’s fields. | Action | 🔗 Github |
companies | Sync Brevo CRM companies, incrementally via the modifiedSince filter with a periodic full refresh to detect deletions. | Sync | 🔗 Github |
contact-lists | Fetches all Brevo contact lists (metadata only, not list membership) via full refresh. | Sync | 🔗 Github |
contacts | Sync Brevo contacts, incrementally via the modifiedSince filter with a periodic full refresh to detect deletions. | Sync | 🔗 Github |
deals | Sync Brevo CRM deals, incrementally via the modifiedSince filter with a periodic full refresh to detect deletions. | Sync | 🔗 Github |
email-campaigns | Full refresh sync of email (classic) campaigns, including their status and delivery statistics. | Sync | 🔗 Github |
email-templates | Sync transactional email templates from Brevo (full refresh with delete detection) | Sync | 🔗 Github |
Access requirements
| Pre-Requisites | Status | Comment |
|---|---|---|
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ |
Setup guide
No setup guide yet.Need help getting started? Get help in the community.
Contribute improvements to the setup guide by editing this page
Useful links
Contribute useful links by editing this page
API gotchas
Contribute API gotchas by editing this page