Install
openclaw skills install @byungkyu/brevo-apiBrevo API integration with managed OAuth. Email marketing, transactional emails, SMS, contacts, and CRM. Use this skill when users want to send emails, manage contacts, create campaigns, or work with Brevo lists and templates. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). Requires network access and valid Maton API key. Calls run through the maton CLI with OAuth login; default to read and list calls, and confirm every write or new connection with the user.
openclaw skills install @byungkyu/brevo-apiAccess the Brevo API with managed OAuth authentication. Send transactional emails, manage contacts and lists, create email campaigns, and work with templates.
All access runs through the Maton gateway and the maton CLI.
maton login --oauth # authenticate once (OAuth, recommended)
maton connection create brevo # connect the account (needs user approval)
maton api '/brevo/v3/account' # first call
npm install -g @maton/cli
brew install maton-ai/cli/maton
maton login --oauth
Opens the OAuth login page in the browser and waits for authorization. Once complete, it creates a profile in config.toml (eg. $HOME/.config/maton/config.toml) and stores the access and refresh tokens in the operating system's credential store (Keychain on macOS, Credential Manager on Windows, Secret Service on Linux), auto-renewed on expiry. The CLI reads them when it needs them; nothing else should.
maton login --interactive
Requires manually copying an API key from Settings, which is error prone. Once complete, it also creates a profile in config.toml and stores the key in the same credential store. It is preferred over export MATON_API_KEY=..., which exposes a long-lived credential to every child process. When MATON_API_KEY is set, it overrides the active profile. If the CLI cannot be installed at all, see Appendix: Environments Without the CLI for the raw HTTP form and the rules for handling the key.
maton whoami --json
{
"authenticated": true,
"profile_name": "alice@example.com",
"auth_type": "oauth"
}
authenticated is false, stop and login again via maton login --oauth.auth_type is api_key, it is recommended to login via maton login --oauth and avoid keeping a long-lived credential.maton connection list brevo --status ACTIVE
{
"connections": [
{
"connection_id": "{connection_id}",
"status": "ACTIVE",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "brevo",
"method": "OAUTH2",
"metadata": {}
}
]
}
Refer to maton connection list --help for possible flags and values.
Requires explicit user approval. Confirm that the user intends to authorize Brevo access before running this. Never create a connection on your own initiative.
maton connection create brevo
Refer to maton connection create --help for possible flags and values.
maton connection get {connection_id}
{
"connection": {
"connection_id": "{connection_id}",
"status": "PENDING",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "brevo",
"metadata": {}
}
}
Open the returned URL in a browser to complete authorizing Brevo. If Brevo offers scope selection, choose only the scopes the current task needs.
maton connection delete {connection_id} --yes
If there are multiple Brevo connections, specify which one to use so requests go to the intended account:
maton api '/brevo/v3/account' --connection {connection_id}
Brevo has no typed maton brevo commands yet, so every call goes through maton api.
maton api '/brevo/v3/account'
Paths are /brevo/{native-api-path}. The gateway forwards everything after the app segment to api.brevo.com and injects the credential for the connection. Query strings, custom headers (except Host and Authorization), and all HTTP methods pass through. Send a JSON body with --input -:
maton api -X POST '/brevo/{native-api-path}' -H 'Content-Type: application/json' --input - <<'JSON'
{"key": "value"}
JSON
Refer to maton api --help for possible flags and values.
maton login --oauth, the token is held by the operating system's credential store and the CLI renews it on its own. Do not print it, write it to a file, pass it on a command line, or run maton token to look at one — only to hand it to a program that needs it.config.toml, or any other credential file — not for this skill, not for another application, and not to "check" that auth works (use maton whoami). Let the CLI use its own stored credential; the agent never needs the value. The same applies to unrelated secrets on the machine: .env files, SSH keys, cloud CLI credentials, and browser profiles are out of scope for an API gateway and must not be read or transmitted.api.maton.ai. Prefer endpoints that work with the gateway-injected connection credential.maton connection delete {connection_id}).maton connection create brevo. Never create connections on the agent's own initiative.--connection when the user has multiple connections for this app, and -p/--profile when they have multiple Maton accounts. Do not let an ambiguous default decide where a write lands.maton api '/brevo/v3/account'
Response:
{
"email": "user@example.com",
"firstName": "John",
"lastName": "Doe",
"companyName": "Acme Inc",
"relay": {
"enabled": true,
"data": {
"userName": "user@smtp-brevo.com",
"relay": "smtp-relay.brevo.com",
"port": 587
}
}
}
maton api '/brevo/v3/contacts'
Query Parameters:
limit - Number of results per page (default: 50, max: 500)offset - Index of first result (0-based)modifiedSince - Filter by modification date (ISO 8601)Response:
{
"contacts": [
{
"id": 1,
"email": "contact@example.com",
"emailBlacklisted": false,
"smsBlacklisted": false,
"createdAt": "2026-02-09T20:33:59.705+01:00",
"modifiedAt": "2026-02-09T20:35:19.529+01:00",
"listIds": [2],
"attributes": {
"FIRSTNAME": "John",
"LASTNAME": "Doe"
}
}
],
"count": 1
}
maton api '/brevo/v3/contacts/{identifier}'
The identifier can be email address, phone number, or contact ID.
Query Parameters:
identifierType - Type of identifier: email_id, phone_id, contact_id, ext_idmaton api -X POST '/brevo/v3/contacts' -H 'Content-Type: application/json' --input - <<'JSON'
{
"email": "newcontact@example.com",
"attributes": {
"FIRSTNAME": "Jane",
"LASTNAME": "Smith"
},
"listIds": [2],
"updateEnabled": false
}
JSON
Response:
{
"id": 2
}
Set updateEnabled: true to update the contact if it already exists.
maton api -X PUT '/brevo/v3/contacts/{identifier}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"attributes": {
"FIRSTNAME": "Updated",
"LASTNAME": "Name"
}
}
JSON
Returns 204 No Content on success.
maton api '/brevo/v3/contacts/{identifier}' -X DELETE
Returns 204 No Content on success.
maton api '/brevo/v3/contacts/{identifier}/campaignStats'
maton api '/brevo/v3/contacts/lists'
Response:
{
"lists": [
{
"id": 2,
"name": "Newsletter Subscribers",
"folderId": 1,
"uniqueSubscribers": 150,
"totalBlacklisted": 2,
"totalSubscribers": 148
}
],
"count": 1
}
maton api '/brevo/v3/contacts/lists/{listId}'
maton api -X POST '/brevo/v3/contacts/lists' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "New List",
"folderId": 1
}
JSON
Response:
{
"id": 3
}
maton api -X PUT '/brevo/v3/contacts/lists/{listId}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "Updated List Name"
}
JSON
Returns 204 No Content on success.
maton api '/brevo/v3/contacts/lists/{listId}' -X DELETE
Returns 204 No Content on success.
maton api '/brevo/v3/contacts/lists/{listId}/contacts'
maton api -X POST '/brevo/v3/contacts/lists/{listId}/contacts/add' -H 'Content-Type: application/json' --input - <<'JSON'
{
"emails": ["contact1@example.com", "contact2@example.com"]
}
JSON
maton api -X POST '/brevo/v3/contacts/lists/{listId}/contacts/remove' -H 'Content-Type: application/json' --input - <<'JSON'
{
"emails": ["contact1@example.com"]
}
JSON
maton api '/brevo/v3/contacts/folders'
Response:
{
"folders": [
{
"id": 1,
"name": "Marketing",
"uniqueSubscribers": 500,
"totalSubscribers": 480,
"totalBlacklisted": 20
}
],
"count": 1
}
maton api '/brevo/v3/contacts/folders/{folderId}'
maton api -X POST '/brevo/v3/contacts/folders' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "New Folder"
}
JSON
Response:
{
"id": 4
}
maton api -X PUT '/brevo/v3/contacts/folders/{folderId}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "Renamed Folder"
}
JSON
Returns 204 No Content on success.
maton api '/brevo/v3/contacts/folders/{folderId}' -X DELETE
Deletes folder and all lists within it. Returns 204 No Content on success.
maton api '/brevo/v3/contacts/folders/{folderId}/lists'
maton api '/brevo/v3/contacts/attributes'
Response:
{
"attributes": [
{
"name": "FIRSTNAME",
"category": "normal",
"type": "text"
},
{
"name": "LASTNAME",
"category": "normal",
"type": "text"
}
]
}
maton api -X POST '/brevo/v3/contacts/attributes/{category}/{attributeName}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"type": "text"
}
JSON
Categories: normal, transactional, category, calculated, global
maton api -X PUT '/brevo/v3/contacts/attributes/{category}/{attributeName}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"value": "new value"
}
JSON
maton api '/brevo/v3/contacts/attributes/{category}/{attributeName}' -X DELETE
maton api -X POST '/brevo/v3/smtp/email' -H 'Content-Type: application/json' --input - <<'JSON'
{
"sender": {
"name": "John Doe",
"email": "john@example.com"
},
"to": [
{
"email": "recipient@example.com",
"name": "Jane Smith"
}
],
"subject": "Welcome!",
"htmlContent": "<html><body><h1>Hello!</h1><p>Welcome to our service.</p></body></html>"
}
JSON
Response:
{
"messageId": "<202602092329.12910305853@smtp-relay.mailin.fr>"
}
Optional Parameters:
cc - Carbon copy recipientsbcc - Blind carbon copy recipientsreplyTo - Reply-to addresstextContent - Plain text versiontemplateId - Use a template instead of htmlContentparams - Template parametersattachment - File attachmentsheaders - Custom headerstags - Email tags for trackingscheduledAt - Schedule for later (ISO 8601)maton api '/brevo/v3/smtp/emails'
Query Parameters:
email - Filter by recipient emailtemplateId - Filter by templatemessageId - Filter by message IDstartDate - Start date (YYYY-MM-DD)endDate - End date (YYYY-MM-DD)limit - Results per pageoffset - Starting indexmaton api '/brevo/v3/smtp/email/{identifier}' -X DELETE
The identifier can be a messageId or batchId.
maton api '/brevo/v3/smtp/statistics/events'
Query Parameters:
limit - Results per pageoffset - Starting indexstartDate - Start dateendDate - End dateemail - Filter by recipientevent - Filter by event type: delivered, opened, clicked, bounced, etc.maton api '/brevo/v3/smtp/templates'
Response:
{
"count": 1,
"templates": [
{
"id": 1,
"name": "Welcome Email",
"subject": "Welcome {{params.name}}!",
"isActive": true,
"sender": {
"name": "Company",
"email": "noreply@company.com"
},
"htmlContent": "<html>...</html>",
"createdAt": "2026-02-09 23:29:38",
"modifiedAt": "2026-02-09 23:29:38"
}
]
}
maton api '/brevo/v3/smtp/templates/{templateId}'
maton api -X POST '/brevo/v3/smtp/templates' -H 'Content-Type: application/json' --input - <<'JSON'
{
"sender": {
"name": "Company",
"email": "noreply@company.com"
},
"templateName": "Welcome Email",
"subject": "Welcome {{params.name}}!",
"htmlContent": "<html><body><h1>Hello {{params.name}}!</h1></body></html>"
}
JSON
Response:
{
"id": 1
}
maton api -X PUT '/brevo/v3/smtp/templates/{templateId}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"templateName": "Updated Template Name",
"subject": "New Subject"
}
JSON
Returns 204 No Content on success.
maton api '/brevo/v3/smtp/templates/{templateId}' -X DELETE
Returns 204 No Content on success.
maton api -X POST '/brevo/v3/smtp/templates/{templateId}/sendTest' -H 'Content-Type: application/json' --input - <<'JSON'
{
"emailTo": ["test@example.com"]
}
JSON
maton api '/brevo/v3/emailCampaigns'
Query Parameters:
type - Filter by type: classic, triggerstatus - Filter by status: draft, sent, archive, queued, suspended, in_processlimit - Results per pageoffset - Starting indexResponse:
{
"count": 1,
"campaigns": [
{
"id": 2,
"name": "Monthly Newsletter",
"subject": "Our March Update",
"type": "classic",
"status": "draft",
"sender": {
"name": "Company",
"email": "news@company.com"
},
"createdAt": "2026-02-09T23:29:39.000Z"
}
]
}
maton api '/brevo/v3/emailCampaigns/{campaignId}'
maton api -X POST '/brevo/v3/emailCampaigns' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "March Newsletter",
"subject": "Our March Update",
"sender": {
"name": "Company",
"email": "news@company.com"
},
"htmlContent": "<html><body><h1>March News</h1></body></html>",
"recipients": {
"listIds": [2]
}
}
JSON
Response:
{
"id": 2
}
maton api -X PUT '/brevo/v3/emailCampaigns/{campaignId}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "Updated Campaign Name",
"subject": "Updated Subject"
}
JSON
Returns 204 No Content on success.
maton api '/brevo/v3/emailCampaigns/{campaignId}' -X DELETE
Returns 204 No Content on success.
maton api -X POST '/brevo/v3/emailCampaigns/{campaignId}/sendNow'
maton api -X POST '/brevo/v3/emailCampaigns/{campaignId}/sendTest' -H 'Content-Type: application/json' --input - <<'JSON'
{
"emailTo": ["test@example.com"]
}
JSON
maton api -X PUT '/brevo/v3/emailCampaigns/{campaignId}/status' -H 'Content-Type: application/json' --input - <<'JSON'
{
"status": "suspended"
}
JSON
maton api '/brevo/v3/senders'
Response:
{
"senders": [
{
"id": 1,
"name": "Company",
"email": "noreply@company.com",
"active": true,
"ips": []
}
]
}
maton api '/brevo/v3/senders/{senderId}'
maton api -X POST '/brevo/v3/senders' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "Marketing",
"email": "marketing@company.com"
}
JSON
maton api -X PUT '/brevo/v3/senders/{senderId}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"name": "Updated Name"
}
JSON
maton api '/brevo/v3/senders/{senderId}' -X DELETE
maton api '/brevo/v3/smtp/blockedContacts'
maton api '/brevo/v3/smtp/blockedContacts/{email}' -X DELETE
maton api '/brevo/v3/smtp/blockedDomains'
maton api -X POST '/brevo/v3/smtp/blockedDomains' -H 'Content-Type: application/json' --input - <<'JSON'
{
"domain": "spam-domain.com"
}
JSON
maton api '/brevo/v3/smtp/blockedDomains/{domain}' -X DELETE
Brevo uses offset-based pagination:
maton api '/brevo/v3/contacts?limit=50&offset=0'
Parameters:
limit - Number of results per page (varies by endpoint, typically max 500)offset - Starting index (0-based)Response includes count:
{
"contacts": [...],
"count": 150
}
To get the next page, increment offset by limit:
offset=0&limit=50offset=50&limit=50offset=100&limit=50/v3/ prefix in the path{{params.name}} syntaxThe CLI above is this skill's documented path; the SDKs are an optional way to call the same gateway from application code. The two modes keep separate credential stores: the CLI uses the profile from maton login, while an SDK program signs in once with login(), which opens a browser and stores a session that Maton() reads. Brevo has no typed accessor yet, so calls go through the api passthrough, which takes the app and the path after it.
Python
pip install maton-ai
from maton_ai import Maton, login
# login()
maton = Maton()
# maton = Maton(api_key="...")
result = maton.api.get("brevo", "/v3/account")
JavaScript
npm install @maton/sdk
import { Maton, login } from "@maton/sdk";
// await login()
const maton = new Maton();
// const maton = new Maton({ apiKey: "..." });
const result = await maton.api.get("brevo", "/v3/account");
| Status | Meaning |
|---|---|
| 400 | Missing Brevo connection |
| 401 | Invalid, missing, or expired Maton credential |
| 429 | Rate limited (10 requests/second per account) |
| 500 | Internal Server Error |
| 4xx/5xx | Passthrough error from the Brevo API |
Errors from Brevo are passed through with their original status codes and response bodies.
maton whoami --json
"authenticated": false — login again with maton login --oauth."auth_type": "api_key" — prefer maton login --oauth so no long-lived key sits on the machine.maton whoami is the check.Then confirm the app is connected:
maton connection list brevo --status ACTIVE
Paths passed to maton api must start with /brevo/:
maton api '/brevo/v3/account'maton api '/v3/account'A 500 may mean the Brevo authorization expired. With the user's approval, create a new connection (maton connection create brevo) and complete authorization; once it is ACTIVE, delete the stale connection so the gateway uses the new one.
maton api.--paginate walks every page and -q/--jq trims the response before it reaches you. On typed commands, --jq requires --json.maton api; Host and Authorization are set by the gateway.Everything above uses the CLI, which holds the credential itself and never exposes it to the caller. Use the raw HTTP form below only where the CLI cannot be installed — a locked-down container, a CI step, a sandbox with no package manager. If maton is available, maton api does the same job without handling a secret.
Calling api.maton.ai directly means holding a long-lived Maton API key in the process environment, where it is readable by every child process and easy to leak into logs, crash dumps, shell history, and pasted output. Handle it accordingly:
[ -n "$MATON_API_KEY" ] && echo "MATON_API_KEY is set" || echo "MATON_API_KEY is not set"
.env, or a script makes it permanent. Let the environment that starts the session supply it — a CI secret store, a container secret, a secrets manager.ps output and shell history. Read it from the environment inside the process that makes the request, as below.api.maton.ai. It is not a credential for Brevo or any other third-party host.The request is a plain HTTPS call to host api.maton.ai at path /brevo/{native-api-path} with a bearer token; the gateway swaps in the connected app's credential. Add a Maton-Connection: {connection_id} header to pin a specific connection when the account has more than one. Query values must be URL-encoded. The Python standard library is enough — the key is read from the environment inside the process, so it never appears on a command line:
python3 - <<'PY'
import json, os, urllib.request
GATEWAY = "https://api.maton.ai"
req = urllib.request.Request(GATEWAY + "/brevo/v3/account")
req.add_header("Authorization", "Bearer " + os.environ["MATON_API_KEY"])
req.add_header("User-Agent", "maton-brevo-skill/1.2")
# req.add_header("Maton-Connection", "{connection_id}")
with urllib.request.urlopen(req) as resp:
print(json.dumps(json.load(resp), indent=2))
PY
For a write, set method="POST" (or PUT/DELETE) on the Request, pass the JSON-encoded body as data=, and add a Content-Type: application/json header.
The same rules as the CLI apply to every request made this way: read-only calls first, and explicit user confirmation before any POST, PUT, PATCH, or DELETE.