Brevo (Sendinblue)
Create contacts and send transactional emails with Brevo (formerly Sendinblue).
Connect
Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("sendinblue", "create_or_update_contact", {
"email": "<email>"
});
if (!res.success) throw new Error(res.error);
ctx.log.info("Brevo (Sendinblue) answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "sendinblue-create-or-update-contact",
name: "Brevo (Sendinblue): Create or Update Contact",
description: "Calls Brevo (Sendinblue) when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("sendinblue", {
"action": "create_or_update_contact",
"email": "<email>"
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/sendinblue/create_or_update_contact" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{"email":"<email>"}}'Actions
create_or_update_contactin catalog
Create or Update Contact. Create or update an existing contact
| Input | Type | Description |
|---|---|---|
emailrequired | text | Email address of the user. Mandatory if "SMS" field is not passed in "attributes" parameter. Mobile Number in SMS field should be passed with proper country code. For example: {"SMS":"+91xxxxxxxxxx"}… |
ext_idoptional | text | Pass your own Id to create a contact. |
attributesoptional | object | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your SendinBlue account. For eg… |
email_blacklistedoptional | boolean | Set this field to blacklist the contact for emails (emailBlacklisted = true) |
sms_blacklistedoptional | boolean | Set this field to blacklist the contact for SMS (smsBlacklisted = true) |
list_idsoptional | array | Ids of the lists to add the contact to. |
smtp_blacklist_senderoptional | boolean | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) |
custom_api_call
Custom API Call. Make a custom API call to a specific endpoint
| Input | Type | Description |
|---|---|---|
urlrequired | object (depends on other props) | url |
methodrequired | one of "GET" | "POST" | "PATCH" | "PUT" | "DELETE" | "HEAD" | Method |
headersrequired | object | Authorization headers are injected automatically from your connection. |
queryParamsrequired | object | Query Parameters |
body_typeoptional | one of "none" | "json" | "form_data" | "raw" | Body Type |
bodyoptional | object (depends on other props) | Body |
response_is_binaryoptional | boolean | Enable for files like PDFs, images, etc. |
failsafeoptional | boolean | No Error on Failure |
timeoutoptional | number | Timeout (in seconds) |
followRedirectsoptional | boolean | Follow redirects |
Details
- Id
sendinblue- Category
- Marketing
- Tags
- email, transactional, sms, marketing
- Package
@activepieces/piece-sendinblue@0.2.4- Tier
- Community