Reference
Brevo
Connect Brevo to Alter Vault for secure API access
Overview
Section titled “Overview”Use Brevo credentials to make authenticated API calls through Alter Vault without exposing API keys in code.
| Property | Value |
|---|---|
| Provider ID | brevo |
| Category | Communication |
| Credential Type | API Key |
Step 1: Get Credentials
Section titled “Step 1: Get Credentials”Log in to your Brevo account
Log in to your Brevo account at app.brevo.com.
Open the API keys & MCP tab
Go to Settings → SMTP & API and open the API keys & MCP tab at app.brevo.com/settings/keys/api.
Generate an API key
Click Generate API key, name the key, set an expiry, and leave the Create MCP server API key option off (the key is sent as Brevo’s REST api-key header).
Copy your API key
Copy the key; it is only shown once.
Step 2: Add to Alter Vault
Section titled “Step 2: Add to Alter Vault”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.
Using in Code
Section titled “Using in Code”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>", },)Policy-cataloged operations
Section titled “Policy-cataloged operations”Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.
| Operation ID | Families | Method | Provider path |
|---|---|---|---|
sendTransacEmail | send | POST | /v3/smtp/email |
sendTransacSms | send | POST | /v3/transactionalSMS/send |
sendEmailCampaignNow | send | POST | /v3/emailCampaigns/{campaignId}/sendNow |
createEmailCampaign | send, write | POST | /v3/emailCampaigns |
getEmailCampaigns | read | GET | /v3/emailCampaigns |
getEmailCampaign | read | GET | /v3/emailCampaigns/{campaignId} |
createContact | write | POST | /v3/contacts |
getContacts | read | GET | /v3/contacts |
getContactInfo | read | GET | /v3/contacts/{identifier} |
updateContact | write | PUT | /v3/contacts/{identifier} |
deleteContact | delete | DELETE | /v3/contacts/{identifier} |
createList | write | POST | /v3/contacts/lists |
getLists | read | GET | /v3/contacts/lists |
addContactToList | write | POST | /v3/contacts/lists/{listId}/contacts/add |
removeContactFromList | write | POST | /v3/contacts/lists/{listId}/contacts/remove |
createSmtpTemplate | write | POST | /v3/smtp/templates |
getSmtpTemplates | read | GET | /v3/smtp/templates |
getSmtpTemplate | read | GET | /v3/smtp/templates/{templateId} |
updateSmtpTemplate | write | PUT | /v3/smtp/templates/{templateId} |
getTransacEmailsList | read | GET | /v3/smtp/emails |
getAggregatedSmtpReport | read | GET | /v3/smtp/statistics/aggregatedReport |
getAccount | read | GET | /v3/account |
getSenders | read | GET | /v3/senders |
getWebhooks | read | GET | /v3/webhooks |
createWebhook | admin | POST | /v3/webhooks |