Brevo setup guide

Agents work with your audiences, campaigns and forms.

Ways to connect

Company admins connect apps, on the Integrations page in Everdeck: open Brevo, choose one of the ways below, follow its steps and fill in its fields. Everdeck checks what you enter before it saves anything, and asks you to confirm it’s you (your second factor) before you type any secret. How connecting works.

Brevo can be connected 2 ways. Where there’s a key or token to paste, that’s usually the quickest.

API key

API key.

1. In Brevo, open SMTP & API settings (https://app.brevo.com/settings/keys/api).
2. On the API keys tab, click Generate a new API key, name it "Everdeck" and click Generate.
3. Copy the key (it is shown once) and paste it here.
4. If your account blocks unknown IP addresses (your name > Security > Authorized IPs), authorize Everdeck's outbound IP addresses first, or the key will be refused.

Field	What to enter
API key	A secret: Everdeck saves it encrypted and never shows it again. Where to find it.

Disconnecting deletes the credentials Everdeck saved, but Everdeck can't revoke them: the key, token or password itself keeps working at Brevo until you delete or rotate it there.

Your Brevo OAuth app

Your OAuth app.

This way signs in with an OAuth app you create for Brevo, as its steps describe: Everdeck never uses an app of its own. Register this redirect URI with your app:

https://everdeck.io/api/oauth/callback

Then save the app’s client ID and secret in Everdeck, on the connect page or under OAuth apps, and sign in.

1. Brevo creates OAuth apps with its CLI. Install it (npm install -g @getbrevo/cli) and run brevo login to sign in to your Brevo account.
2. Run brevo app create --name Everdeck --redirect-uri https://everdeck.io/api/oauth/callback. This creates a private user-consent OAuth app (not Machine to Machine) and writes app-config.json; you can decline the offer to scaffold the test app.
3. In app-config.json replace auth.scopes with the scopes listed below (new apps start with contacts and CRM scopes only), check that auth.redirect_uris holds https://everdeck.io/api/oauth/callback, then run brevo app upload.
4. Run brevo app credentials --app-id <your app id> --reveal-secret and copy the Client ID and Client secret into the form.
5. Click Connect and approve as a user of the same Brevo organisation (Brevo OAuth apps are private to the organisation that created them).

The scopes Everdeck asks for:

• account:read
• contacts:read
• contacts:write
• campaigns.email:read
• campaigns.email:write
• transactional.email:write
• crm:write
• webhooks:read
• webhooks:write

Disconnecting deletes the tokens Everdeck saved. Brevo documents no revocation endpoint: revoke the access in Brevo.

What agents can do

An agent uses an action only when its charter grants it, on the agent’s Tools tab, where you choose whether each one runs by itself (Auto), asks first or never runs. Each action has a risk tier: tier 3 actions, which customers or the public see, ask first unless you choose otherwise, and tier 4 actions (money, deleting things, access) always need a person. How tools and tiers work.

Actions marked Reads outside content return things people outside your company may have written. Agents treat what they read as information, never as instructions, and their riskier actions later in the same session need approval.

• Find contactsTier 0 · ReadReads outside contentbrevo_search_contacts

  List contacts, newest first, filtered by an attribute value, a list or a segment, or changed since a date. Returns email, attributes, list ids and blocklist flags.

• Read a contactTier 0 · ReadReads outside contentbrevo_get_contact

  Read one contact by email, contact id, SMS number or your own EXT_ID, with attributes, lists, blocklist flags and recent campaign activity (last 90 days).

• Create or update a contactTier 2 · Reversiblebrevo_upsert_contact

  Create a contact, or update the existing one with this email or EXT_ID. Attribute names are in capitals (FIRSTNAME, LASTNAME, SMS, or your custom ones) and must already exist in Brevo. This does not add them to any list.

• Add contacts to a listTier 3 · ExternalReads outside contentbrevo_add_contacts_to_list

  Add existing contacts to a list by email (up to 150 at a time). People on a list receive the campaigns sent to it, so only add those who agreed to hear from you.

• List contact listsTier 0 · ReadReads outside contentbrevo_list_lists

  List contact lists with their ids, folder and number of unique subscribers.

• Send an emailTier 3 · Externalbrevo_send_transactional_email

  Send a one-to-one transactional email, either from HTML you write or from a Brevo template with parameters. The sender must be a verified sender or domain in Brevo.

• List email campaignsTier 0 · ReadReads outside contentbrevo_list_email_campaigns

  List email campaigns, newest first, with status, subject, recipients and headline statistics (sent, delivered, unique opens and clicks, unsubscribes, bounces).

• Read a campaign reportTier 0 · ReadReads outside contentbrevo_get_email_campaign

  Read one email campaign with its settings and full statistics: sent, delivered, opens (including Apple privacy opens), clicks, unsubscribes, bounces and complaints.

• Draft an email campaignTier 2 · Reversiblebrevo_create_email_campaign

  Create a draft email campaign for one or more lists with its subject, sender and HTML body. Nothing is sent until send_email_campaign_now. Link to {{ unsubscribe }} in the HTML, for example <a href="{{ unsubscribe }}">Unsubscribe</a>.

• Send a test of a campaignTier 3 · ExternalReads outside contentbrevo_send_test_email

  Send a test version of a campaign to a few addresses (at most 50 test emails a day in total).

• Send a campaign nowTier 3 · ExternalReads outside contentbrevo_send_email_campaign_now

  Send a ready campaign to its lists immediately. Brevo checks your send limit and credits first. Cannot be undone.

• Add a CRM noteTier 2 · Reversiblebrevo_add_crm_note

  Add an internal note to one or more contacts (and optionally deals or companies) in Brevo's sales CRM.

Testing, problems and disconnecting

Everdeck checks the connection when you save it. On the connection’s page in Integrations, Test checks it again at any time.

If Brevo later refuses the connection, for example because a key was deleted or a sign-in expired, the connection shows Needs attention on the Integrations page and the people who manage connections are told. Agents can’t use it until a company admin fixes it with Edit or Reconnect.

To stop agents using Brevo, open the connection and select Disconnect. Agents stop using it at once and its saved credentials are deleted. What else happens depends on how it was connected: each way above says.