​

What’s supported

​

Supported actions

This connector supports:

• Read Actions, including full historic backfill. Please note that incremental read is not supported, a full read of the Brevo instance will be done for each scheduled read.
• Write Actions.
• Proxy Actions, using the base URL https://api.brevo.com.

​

Supported Objects

The Brevo connector supports the following objects:

• categories (read and write)
• categories/batch (write only)
• companies (read and write)
• companies/import (write only)
• companies/attributes (read only)
• conversations/agentOnlinePing (write only)
• conversations/messages (write only)
• conversations/pushedMessages (write only)
• contacts (read and write)
• contacts/doubleOptinConfirmation (write only)
• contacts/export (write only)
• contacts/folders (read only)
• contacts/import (write only)
• coupons (read only)
• crm/deals (read and write)
• crm/deals/import (write only)
• crm/notes (read and write)
• crm/tasks (read and write)
• crm/attributes (read only)
• emailCampaigns (read and write)
• emailCampaigns/images (write only)
• ecommerce/activate (write only)
• ecommerce/config/displayCurrency (write only)
• events (write only)
• externalFeeds (read only)
• files (read only)
• feeds (write only)
• folders (read only)
• ips (read only)
• inbound/events (read only)
• loyalty/config/programs (write only)
• lists (read only)
• orders/status (write only)
• orders/status/batch (write only)
• products (read and write)
• senders (read and write)
• senders/domains (write only)
• smtp/statistics/events (read only)
• smtp/statistics/reports (read only)
• smsCampaigns (read only)
• subAccount (read only)
• templates (read only)
• transactionalSMS/statistics/events (read only)
• transactionalSMS/statistics/reports (read only)
• webhooks (read and write)
• webhooks/export (write only)

​

Using the connector

This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)

To start integrating with Brevo:

• Create a manifest file like the example.
• Deploy it using the amp CLI.
• If you are using Read Actions, create a destination.
• Embed the InstallIntegration UI component. The UI component will prompt the customer for an API key.
• Start using the connector!
  • If your integration has Read Actions, you’ll start getting webhook messages.
  • If your integration has Write Actions, you can start making API calls to our Write API.
  • If your integration has Proxy Actions, you can start making Proxy API calls.

​

Creating an API key for Brevo

Click here for more information about generating an API key for Brevo. The UI components will display this link, so that your users can successfully create API keys.