Skip to content

Reference

Brevo

Connect Brevo to Alter Vault for secure API access

Use Brevo credentials to make authenticated API calls through Alter Vault without exposing API keys in code.

PropertyValue
Provider IDbrevo
CategoryCommunication
Credential TypeAPI Key

Log in to your Brevo account

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

Go to Settings → SMTP & API → API Keys

Go to Settings → SMTP & API → API Keys at app.brevo.com/settings/keys/api.

Generate a new API key

Click ‘Generate a new API key’.

Copy your API key

Copy the generated API key.

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add Brevo

Go to Managed Secrets > Add Provider > Brevo.

Enter credentials

Paste your API Key into the credential field.

Save

Click Save. You’ll receive a grant_id to use with the SDK.

response = await alter_app.request(
HttpMethod.POST,
"https://api.brevo.com/v3/smtp/email",
grant_id="YOUR_GRANT_ID",
json={
"sender": {"name": "Alter", "email": "sender@YOUR_VERIFIED_DOMAIN"},
"to": [{"email": "recipient@example.com"}],
"subject": "Hello",
"htmlContent": "<p>Hello from Alter</p>",
},
)

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation IDFamiliesMethodProvider path
sendTransacEmailsendPOST/v3/smtp/email
sendTransacSmssendPOST/v3/transactionalSMS/send
sendEmailCampaignNowsendPOST/v3/emailCampaigns/{campaignId}/sendNow
createEmailCampaignsend, writePOST/v3/emailCampaigns
getEmailCampaignsreadGET/v3/emailCampaigns
getEmailCampaignreadGET/v3/emailCampaigns/{campaignId}
createContactwritePOST/v3/contacts
getContactsreadGET/v3/contacts
getContactInforeadGET/v3/contacts/{identifier}
updateContactwritePUT/v3/contacts/{identifier}
deleteContactdeleteDELETE/v3/contacts/{identifier}
createListwritePOST/v3/contacts/lists
getListsreadGET/v3/contacts/lists
addContactToListwritePOST/v3/contacts/lists/{listId}/contacts/add
removeContactFromListwritePOST/v3/contacts/lists/{listId}/contacts/remove
createSmtpTemplatewritePOST/v3/smtp/templates
getSmtpTemplatesreadGET/v3/smtp/templates
getSmtpTemplatereadGET/v3/smtp/templates/{templateId}
updateSmtpTemplatewritePUT/v3/smtp/templates/{templateId}
getTransacEmailsListreadGET/v3/smtp/emails
getAggregatedSmtpReportreadGET/v3/smtp/statistics/aggregatedReport
getAccountreadGET/v3/account
getSendersreadGET/v3/senders
getWebhooksreadGET/v3/webhooks
createWebhookadminPOST/v3/webhooks

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.