KosmoKrator

productivity

Brevo Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Brevo KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.brevo.*. Use lua_read_doc("integrations.brevo") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Brevo workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.brevo.activate_ecommerce({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("brevo"))' --json
kosmo integrations:lua --eval 'print(docs.read("brevo.activate_ecommerce"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local brevo = app.integrations.brevo
local result = brevo.activate_ecommerce({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.brevo, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.brevo.default.* or app.integrations.brevo.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Brevo, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Brevo Lua Reference

Namespace: app.integrations.brevo

Brevo tools use the api-key header against the v3 API. Request and response payloads are decoded Brevo JSON and keep Brevo field names such as listIds, htmlContent, sender, and templateId.

Common Workflows

Create or update a contact:

app.integrations.brevo.create_contact({
  email = "person@example.test",
  attributes = {
    FIRSTNAME = "Ada"
  },
  list_ids = { 12 },
  update_enabled = true
})

Send a transactional email:

app.integrations.brevo.send_email({
  payload = {
    sender = { email = "noreply@example.test", name = "Example" },
    to = {
      { email = "person@example.test", name = "Ada" }
    },
    subject = "Welcome",
    htmlContent = "<p>Hello Ada</p>"
  }
})

Create an email campaign:

local campaign = app.integrations.brevo.create_email_campaign({
  payload = {
    name = "Launch update",
    subject = "Launch update",
    sender = { id = 3 },
    recipients = { listIds = { 12 } },
    htmlContent = "<p>News</p>"
  }
})

Coverage Notes

  • Contact tools cover contacts, attributes, lists, folders, list membership, imports, and exports.
  • Messaging tools cover transactional email, templates, SMTP logs/statistics, blocked recipients/domains, transactional SMS, and WhatsApp.
  • Campaign tools cover email, SMS, and WhatsApp campaigns plus send-now and template approval operations.
  • Account/settings tools cover senders, sender domains, webhooks, inbound parsing, external feeds, and process status.
  • eCommerce and event tools cover products, categories, order status, custom events, custom object records, and eCommerce activation.
  • Raw api_get, api_post, api_put, api_patch, and api_delete can call any Brevo v3 endpoint path.

Use payload for full Brevo request bodies when a focused tool does not expose every optional field.

Raw agent markdown 
# Brevo Lua Reference

Namespace: `app.integrations.brevo`

Brevo tools use the `api-key` header against the v3 API. Request and response payloads are decoded Brevo JSON and keep Brevo field names such as `listIds`, `htmlContent`, `sender`, and `templateId`.

## Common Workflows

Create or update a contact:

```lua
app.integrations.brevo.create_contact({
  email = "person@example.test",
  attributes = {
    FIRSTNAME = "Ada"
  },
  list_ids = { 12 },
  update_enabled = true
})
```

Send a transactional email:

```lua
app.integrations.brevo.send_email({
  payload = {
    sender = { email = "noreply@example.test", name = "Example" },
    to = {
      { email = "person@example.test", name = "Ada" }
    },
    subject = "Welcome",
    htmlContent = "<p>Hello Ada</p>"
  }
})
```

Create an email campaign:

```lua
local campaign = app.integrations.brevo.create_email_campaign({
  payload = {
    name = "Launch update",
    subject = "Launch update",
    sender = { id = 3 },
    recipients = { listIds = { 12 } },
    htmlContent = "<p>News</p>"
  }
})
```

## Coverage Notes

- Contact tools cover contacts, attributes, lists, folders, list membership, imports, and exports.
- Messaging tools cover transactional email, templates, SMTP logs/statistics, blocked recipients/domains, transactional SMS, and WhatsApp.
- Campaign tools cover email, SMS, and WhatsApp campaigns plus send-now and template approval operations.
- Account/settings tools cover senders, sender domains, webhooks, inbound parsing, external feeds, and process status.
- eCommerce and event tools cover products, categories, order status, custom events, custom object records, and eCommerce activation.
- Raw `api_get`, `api_post`, `api_put`, `api_patch`, and `api_delete` can call any Brevo v3 endpoint path.

Use `payload` for full Brevo request bodies when a focused tool does not expose every optional field.
Metadata-derived Lua example 
local result = app.integrations.brevo.activate_ecommerce({})
print(result)

Functions

activate_ecommerce Write

Activate eCommerce features for Brevo.

Lua path
app.integrations.brevo.activate_ecommerce
Full name
brevo.brevo_activate_ecommerce
ParameterTypeRequiredDescription
No parameters.
add_contacts_list Write

Add contacts to a contact list.

Lua path
app.integrations.brevo.add_contacts_list
Full name
brevo.brevo_add_contacts_to_list
ParameterTypeRequiredDescription
No parameters.
api_delete Write

Call any Brevo API DELETE endpoint path.

Lua path
app.integrations.brevo.api_delete
Full name
brevo.brevo_api_delete
ParameterTypeRequiredDescription
No parameters.
api_get Read

Call any Brevo API GET endpoint path.

Lua path
app.integrations.brevo.api_get
Full name
brevo.brevo_api_get
ParameterTypeRequiredDescription
No parameters.
api_patch Write

Call any Brevo API PATCH endpoint path.

Lua path
app.integrations.brevo.api_patch
Full name
brevo.brevo_api_patch
ParameterTypeRequiredDescription
No parameters.
api_post Write

Call any Brevo API POST endpoint path.

Lua path
app.integrations.brevo.api_post
Full name
brevo.brevo_api_post
ParameterTypeRequiredDescription
No parameters.
api_put Write

Call any Brevo API PUT endpoint path.

Lua path
app.integrations.brevo.api_put
Full name
brevo.brevo_api_put
ParameterTypeRequiredDescription
No parameters.
authenticate_sender_domain Write

Authenticate a sender domain.

Lua path
app.integrations.brevo.authenticate_sender_domain
Full name
brevo.brevo_authenticate_sender_domain
ParameterTypeRequiredDescription
No parameters.
batch_upsert_categories Write

Batch upsert eCommerce categories.

Lua path
app.integrations.brevo.batch_upsert_categories
Full name
brevo.brevo_batch_upsert_categories
ParameterTypeRequiredDescription
No parameters.
batch_upsert_custom_object_records Write

Batch upsert custom object records.

Lua path
app.integrations.brevo.batch_upsert_custom_object_records
Full name
brevo.brevo_batch_upsert_custom_object_records
ParameterTypeRequiredDescription
No parameters.
batch_upsert_order_statuses Write

Batch upsert eCommerce order statuses.

Lua path
app.integrations.brevo.batch_upsert_order_statuses
Full name
brevo.brevo_batch_upsert_order_statuses
ParameterTypeRequiredDescription
No parameters.
batch_upsert_products Write

Batch upsert eCommerce products.

Lua path
app.integrations.brevo.batch_upsert_products
Full name
brevo.brevo_batch_upsert_products
ParameterTypeRequiredDescription
No parameters.
create_attribute Write

Create a contact attribute.

Lua path
app.integrations.brevo.create_attribute
Full name
brevo.brevo_create_attribute
ParameterTypeRequiredDescription
No parameters.
create_blocked_domain Write

Create a blocked SMTP domain.

Lua path
app.integrations.brevo.create_blocked_domain
Full name
brevo.brevo_create_blocked_domain
ParameterTypeRequiredDescription
No parameters.
create_category Write

Create an eCommerce category.

Lua path
app.integrations.brevo.create_category
Full name
brevo.brevo_create_category
ParameterTypeRequiredDescription
No parameters.
create_contact Write

Create a contact.

Lua path
app.integrations.brevo.create_contact
Full name
brevo.brevo_create_contact
ParameterTypeRequiredDescription
No parameters.
create_email_campaign Write

Create an email campaign.

Lua path
app.integrations.brevo.create_email_campaign
Full name
brevo.brevo_create_email_campaign
ParameterTypeRequiredDescription
No parameters.
create_event Write

Create a custom event.

Lua path
app.integrations.brevo.create_event
Full name
brevo.brevo_create_event
ParameterTypeRequiredDescription
No parameters.
create_events_batch Write

Create custom events in batch.

Lua path
app.integrations.brevo.create_events_batch
Full name
brevo.brevo_create_events_batch
ParameterTypeRequiredDescription
No parameters.
create_external_feed Write

Create an external feed.

Lua path
app.integrations.brevo.create_external_feed
Full name
brevo.brevo_create_external_feed
ParameterTypeRequiredDescription
No parameters.
create_folder Write

Create a contact folder.

Lua path
app.integrations.brevo.create_folder
Full name
brevo.brevo_create_folder
ParameterTypeRequiredDescription
No parameters.
create_inbound_attachment_download_token Write

Create an inbound attachment download token.

Lua path
app.integrations.brevo.create_inbound_attachment_download_token
Full name
brevo.brevo_create_inbound_attachment_download_token
ParameterTypeRequiredDescription
No parameters.
create_list Write

Create a contact list.

Lua path
app.integrations.brevo.create_list
Full name
brevo.brevo_create_list
ParameterTypeRequiredDescription
No parameters.
create_order_status Write

Create or update an eCommerce order status.

Lua path
app.integrations.brevo.create_order_status
Full name
brevo.brevo_create_order_status
ParameterTypeRequiredDescription
No parameters.
create_product Write

Create an eCommerce product.

Lua path
app.integrations.brevo.create_product
Full name
brevo.brevo_create_product
ParameterTypeRequiredDescription
No parameters.
create_sender Write

Create a sender.

Lua path
app.integrations.brevo.create_sender
Full name
brevo.brevo_create_sender
ParameterTypeRequiredDescription
No parameters.
create_sender_domain Write

Create a sender domain.

Lua path
app.integrations.brevo.create_sender_domain
Full name
brevo.brevo_create_sender_domain
ParameterTypeRequiredDescription
No parameters.
create_sms_campaign Write

Create an SMS campaign.

Lua path
app.integrations.brevo.create_sms_campaign
Full name
brevo.brevo_create_sms_campaign
ParameterTypeRequiredDescription
No parameters.
create_smtp_template Write

Create an SMTP template.

Lua path
app.integrations.brevo.create_smtp_template
Full name
brevo.brevo_create_smtp_template
ParameterTypeRequiredDescription
No parameters.
create_webhook Write

Create a webhook.

Lua path
app.integrations.brevo.create_webhook
Full name
brevo.brevo_create_webhook
ParameterTypeRequiredDescription
No parameters.
create_whatsapp_campaign Write

Create a WhatsApp campaign.

Lua path
app.integrations.brevo.create_whatsapp_campaign
Full name
brevo.brevo_create_whatsapp_campaign
ParameterTypeRequiredDescription
No parameters.
create_whatsapp_template Write

Create a WhatsApp template.

Lua path
app.integrations.brevo.create_whatsapp_template
Full name
brevo.brevo_create_whatsapp_template
ParameterTypeRequiredDescription
No parameters.
delete_attribute Write

Delete a contact attribute.

Lua path
app.integrations.brevo.delete_attribute
Full name
brevo.brevo_delete_attribute
ParameterTypeRequiredDescription
No parameters.
delete_blocked_contact Write

Unblock an SMTP contact.

Lua path
app.integrations.brevo.delete_blocked_contact
Full name
brevo.brevo_delete_blocked_contact
ParameterTypeRequiredDescription
No parameters.
delete_blocked_domain Write

Delete a blocked SMTP domain.

Lua path
app.integrations.brevo.delete_blocked_domain
Full name
brevo.brevo_delete_blocked_domain
ParameterTypeRequiredDescription
No parameters.
delete_category Write

Delete an eCommerce category.

Lua path
app.integrations.brevo.delete_category
Full name
brevo.brevo_delete_category
ParameterTypeRequiredDescription
No parameters.
delete_contact Write

Delete a contact.

Lua path
app.integrations.brevo.delete_contact
Full name
brevo.brevo_delete_contact
ParameterTypeRequiredDescription
No parameters.
delete_email_campaign Write

Delete an email campaign.

Lua path
app.integrations.brevo.delete_email_campaign
Full name
brevo.brevo_delete_email_campaign
ParameterTypeRequiredDescription
No parameters.
delete_external_feed Write

Delete an external feed.

Lua path
app.integrations.brevo.delete_external_feed
Full name
brevo.brevo_delete_external_feed
ParameterTypeRequiredDescription
No parameters.
delete_folder Write

Delete a contact folder.

Lua path
app.integrations.brevo.delete_folder
Full name
brevo.brevo_delete_folder
ParameterTypeRequiredDescription
No parameters.
delete_list Write

Delete a contact list.

Lua path
app.integrations.brevo.delete_list
Full name
brevo.brevo_delete_list
ParameterTypeRequiredDescription
No parameters.
delete_product Write

Delete an eCommerce product.

Lua path
app.integrations.brevo.delete_product
Full name
brevo.brevo_delete_product
ParameterTypeRequiredDescription
No parameters.
delete_sender Write

Delete a sender.

Lua path
app.integrations.brevo.delete_sender
Full name
brevo.brevo_delete_sender
ParameterTypeRequiredDescription
No parameters.
delete_sender_domain Write

Delete a sender domain.

Lua path
app.integrations.brevo.delete_sender_domain
Full name
brevo.brevo_delete_sender_domain
ParameterTypeRequiredDescription
No parameters.
delete_sms_campaign Write

Delete an SMS campaign.

Lua path
app.integrations.brevo.delete_sms_campaign
Full name
brevo.brevo_delete_sms_campaign
ParameterTypeRequiredDescription
No parameters.
delete_smtp_template Write

Delete an SMTP template.

Lua path
app.integrations.brevo.delete_smtp_template
Full name
brevo.brevo_delete_smtp_template
ParameterTypeRequiredDescription
No parameters.
delete_transactional_email Write

Delete a scheduled transactional email.

Lua path
app.integrations.brevo.delete_transactional_email
Full name
brevo.brevo_delete_transactional_email
ParameterTypeRequiredDescription
No parameters.
delete_webhook Write

Delete a webhook.

Lua path
app.integrations.brevo.delete_webhook
Full name
brevo.brevo_delete_webhook
ParameterTypeRequiredDescription
No parameters.
delete_whatsapp_campaign Write

Delete a WhatsApp campaign.

Lua path
app.integrations.brevo.delete_whatsapp_campaign
Full name
brevo.brevo_delete_whatsapp_campaign
ParameterTypeRequiredDescription
No parameters.
download_inbound_attachment Read

Download an inbound attachment by download token.

Lua path
app.integrations.brevo.download_inbound_attachment
Full name
brevo.brevo_download_inbound_attachment
ParameterTypeRequiredDescription
No parameters.
export_contacts Write

Export contacts from Brevo.

Lua path
app.integrations.brevo.export_contacts
Full name
brevo.brevo_export_contacts
ParameterTypeRequiredDescription
No parameters.
export_webhooks Write

Export webhook logs.

Lua path
app.integrations.brevo.export_webhooks
Full name
brevo.brevo_export_webhooks
ParameterTypeRequiredDescription
No parameters.
get_account Read

Get Brevo account information.

Lua path
app.integrations.brevo.get_account
Full name
brevo.brevo_get_account
ParameterTypeRequiredDescription
No parameters.
get_category Read

Get an eCommerce category.

Lua path
app.integrations.brevo.get_category
Full name
brevo.brevo_get_category
ParameterTypeRequiredDescription
No parameters.
get_contact Read

Get a contact by email, phone, or identifier.

Lua path
app.integrations.brevo.get_contact
Full name
brevo.brevo_get_contact
ParameterTypeRequiredDescription
No parameters.
get_email_campaign Read

Get an email campaign.

Lua path
app.integrations.brevo.get_email_campaign
Full name
brevo.brevo_get_email_campaign
ParameterTypeRequiredDescription
No parameters.
get_email_status Read

Get transactional email status by identifier.

Lua path
app.integrations.brevo.get_email_status
Full name
brevo.brevo_get_email_status
ParameterTypeRequiredDescription
No parameters.
get_external_feed Read

Get an external feed.

Lua path
app.integrations.brevo.get_external_feed
Full name
brevo.brevo_get_external_feed
ParameterTypeRequiredDescription
No parameters.
get_folder Read

Get a contact folder.

Lua path
app.integrations.brevo.get_folder
Full name
brevo.brevo_get_folder
ParameterTypeRequiredDescription
No parameters.
get_inbound_event Read

Get an inbound parsing event.

Lua path
app.integrations.brevo.get_inbound_event
Full name
brevo.brevo_get_inbound_event
ParameterTypeRequiredDescription
No parameters.
get_list Read

Get a contact list.

Lua path
app.integrations.brevo.get_list
Full name
brevo.brevo_get_list
ParameterTypeRequiredDescription
No parameters.
get_process Read

Get process status.

Lua path
app.integrations.brevo.get_process
Full name
brevo.brevo_get_process
ParameterTypeRequiredDescription
No parameters.
get_product Read

Get an eCommerce product.

Lua path
app.integrations.brevo.get_product
Full name
brevo.brevo_get_product
ParameterTypeRequiredDescription
No parameters.
get_sender_domain Read

Get a sender domain.

Lua path
app.integrations.brevo.get_sender_domain
Full name
brevo.brevo_get_sender_domain
ParameterTypeRequiredDescription
No parameters.
get_sms_campaign Read

Get an SMS campaign.

Lua path
app.integrations.brevo.get_sms_campaign
Full name
brevo.brevo_get_sms_campaign
ParameterTypeRequiredDescription
No parameters.
get_smtp_aggregated_report Read

Get SMTP aggregated report.

Lua path
app.integrations.brevo.get_smtp_aggregated_report
Full name
brevo.brevo_get_smtp_aggregated_report
ParameterTypeRequiredDescription
No parameters.
get_smtp_template Read

Get an SMTP template.

Lua path
app.integrations.brevo.get_smtp_template
Full name
brevo.brevo_get_smtp_template
ParameterTypeRequiredDescription
No parameters.
get_transactional_email Read

Get a transactional email log by UUID.

Lua path
app.integrations.brevo.get_transactional_email
Full name
brevo.brevo_get_transactional_email
ParameterTypeRequiredDescription
No parameters.
get_transactional_sms_aggregated_report Read

Get transactional SMS aggregated report.

Lua path
app.integrations.brevo.get_transactional_sms_aggregated_report
Full name
brevo.brevo_get_transactional_sms_aggregated_report
ParameterTypeRequiredDescription
No parameters.
get_webhook Read

Get a webhook.

Lua path
app.integrations.brevo.get_webhook
Full name
brevo.brevo_get_webhook
ParameterTypeRequiredDescription
No parameters.
get_whatsapp_campaign Read

Get a WhatsApp campaign.

Lua path
app.integrations.brevo.get_whatsapp_campaign
Full name
brevo.brevo_get_whatsapp_campaign
ParameterTypeRequiredDescription
No parameters.
get_whatsapp_config Read

Get WhatsApp configuration.

Lua path
app.integrations.brevo.get_whatsapp_config
Full name
brevo.brevo_get_whatsapp_config
ParameterTypeRequiredDescription
No parameters.
import_contacts Write

Import contacts into Brevo.

Lua path
app.integrations.brevo.import_contacts
Full name
brevo.brevo_import_contacts
ParameterTypeRequiredDescription
No parameters.
list_attributes Read

List contact attributes.

Lua path
app.integrations.brevo.list_attributes
Full name
brevo.brevo_list_attributes
ParameterTypeRequiredDescription
No parameters.
list_blocked_contacts Read

List blocked SMTP contacts.

Lua path
app.integrations.brevo.list_blocked_contacts
Full name
brevo.brevo_list_blocked_contacts
ParameterTypeRequiredDescription
No parameters.
list_blocked_domains Read

List blocked SMTP domains.

Lua path
app.integrations.brevo.list_blocked_domains
Full name
brevo.brevo_list_blocked_domains
ParameterTypeRequiredDescription
No parameters.
list_categories Read

List eCommerce categories.

Lua path
app.integrations.brevo.list_categories
Full name
brevo.brevo_list_categories
ParameterTypeRequiredDescription
No parameters.
list_contacts Read

List contacts in Brevo.

Lua path
app.integrations.brevo.list_contacts
Full name
brevo.brevo_list_contacts
ParameterTypeRequiredDescription
No parameters.
list_contacts_list Read

List contacts in a contact list.

Lua path
app.integrations.brevo.list_contacts_list
Full name
brevo.brevo_list_contacts_in_list
ParameterTypeRequiredDescription
No parameters.
list_custom_object_records Read

List custom object records.

Lua path
app.integrations.brevo.list_custom_object_records
Full name
brevo.brevo_list_custom_object_records
ParameterTypeRequiredDescription
No parameters.
list_email_campaigns Read

List email campaigns.

Lua path
app.integrations.brevo.list_email_campaigns
Full name
brevo.brevo_list_email_campaigns
ParameterTypeRequiredDescription
No parameters.
list_events Read

List custom events.

Lua path
app.integrations.brevo.list_events
Full name
brevo.brevo_list_events
ParameterTypeRequiredDescription
No parameters.
list_external_feeds Read

List external feeds.

Lua path
app.integrations.brevo.list_external_feeds
Full name
brevo.brevo_list_external_feeds
ParameterTypeRequiredDescription
No parameters.
list_folder_lists Read

List contact lists in a folder.

Lua path
app.integrations.brevo.list_folder_lists
Full name
brevo.brevo_list_folder_lists
ParameterTypeRequiredDescription
No parameters.
list_folders Read

List contact folders.

Lua path
app.integrations.brevo.list_folders
Full name
brevo.brevo_list_folders
ParameterTypeRequiredDescription
No parameters.
list_inbound_events Read

List inbound parsing events.

Lua path
app.integrations.brevo.list_inbound_events
Full name
brevo.brevo_list_inbound_events
ParameterTypeRequiredDescription
No parameters.
list_lists Read

List contact lists.

Lua path
app.integrations.brevo.list_lists
Full name
brevo.brevo_list_lists
ParameterTypeRequiredDescription
No parameters.
list_products Read

List eCommerce products.

Lua path
app.integrations.brevo.list_products
Full name
brevo.brevo_list_products
ParameterTypeRequiredDescription
No parameters.
list_sender_domains Read

List sender domains.

Lua path
app.integrations.brevo.list_sender_domains
Full name
brevo.brevo_list_sender_domains
ParameterTypeRequiredDescription
No parameters.
list_senders Read

List senders.

Lua path
app.integrations.brevo.list_senders
Full name
brevo.brevo_list_senders
ParameterTypeRequiredDescription
No parameters.
list_sms_campaigns Read

List SMS campaigns.

Lua path
app.integrations.brevo.list_sms_campaigns
Full name
brevo.brevo_list_sms_campaigns
ParameterTypeRequiredDescription
No parameters.
list_smtp_events Read

List SMTP events.

Lua path
app.integrations.brevo.list_smtp_events
Full name
brevo.brevo_list_smtp_events
ParameterTypeRequiredDescription
No parameters.
list_smtp_reports Read

List SMTP reports.

Lua path
app.integrations.brevo.list_smtp_reports
Full name
brevo.brevo_list_smtp_reports
ParameterTypeRequiredDescription
No parameters.
list_smtp_templates Read

List SMTP templates.

Lua path
app.integrations.brevo.list_smtp_templates
Full name
brevo.brevo_list_smtp_templates
ParameterTypeRequiredDescription
No parameters.
list_transactional_emails Read

List transactional email logs.

Lua path
app.integrations.brevo.list_transactional_emails
Full name
brevo.brevo_list_transactional_emails
ParameterTypeRequiredDescription
No parameters.
list_transactional_sms_events Read

List transactional SMS events.

Lua path
app.integrations.brevo.list_transactional_sms_events
Full name
brevo.brevo_list_transactional_sms_events
ParameterTypeRequiredDescription
No parameters.
list_transactional_sms_reports Read

List transactional SMS reports.

Lua path
app.integrations.brevo.list_transactional_sms_reports
Full name
brevo.brevo_list_transactional_sms_reports
ParameterTypeRequiredDescription
No parameters.
list_webhooks Read

List webhooks.

Lua path
app.integrations.brevo.list_webhooks
Full name
brevo.brevo_list_webhooks
ParameterTypeRequiredDescription
No parameters.
list_whatsapp_campaigns Read

List WhatsApp campaigns.

Lua path
app.integrations.brevo.list_whatsapp_campaigns
Full name
brevo.brevo_list_whatsapp_campaigns
ParameterTypeRequiredDescription
No parameters.
list_whatsapp_events Read

List WhatsApp transactional events.

Lua path
app.integrations.brevo.list_whatsapp_events
Full name
brevo.brevo_list_whatsapp_events
ParameterTypeRequiredDescription
No parameters.
list_whatsapp_templates Read

List WhatsApp templates.

Lua path
app.integrations.brevo.list_whatsapp_templates
Full name
brevo.brevo_list_whatsapp_templates
ParameterTypeRequiredDescription
No parameters.
remove_contacts_from_list Write

Remove contacts from a contact list.

Lua path
app.integrations.brevo.remove_contacts_from_list
Full name
brevo.brevo_remove_contacts_from_list
ParameterTypeRequiredDescription
No parameters.
send_email Write

Send a transactional email.

Lua path
app.integrations.brevo.send_email
Full name
brevo.brevo_send_email
ParameterTypeRequiredDescription
No parameters.
send_email_campaign_now Write

Send an email campaign immediately.

Lua path
app.integrations.brevo.send_email_campaign_now
Full name
brevo.brevo_send_email_campaign_now
ParameterTypeRequiredDescription
No parameters.
send_sms_campaign_now Write

Send an SMS campaign immediately.

Lua path
app.integrations.brevo.send_sms_campaign_now
Full name
brevo.brevo_send_sms_campaign_now
ParameterTypeRequiredDescription
No parameters.
send_smtp_template_test Write

Send a test for an SMTP template.

Lua path
app.integrations.brevo.send_smtp_template_test
Full name
brevo.brevo_send_smtp_template_test
ParameterTypeRequiredDescription
No parameters.
send_transactional_sms Write

Send a transactional SMS.

Lua path
app.integrations.brevo.send_transactional_sms
Full name
brevo.brevo_send_transactional_sms
ParameterTypeRequiredDescription
No parameters.
send_whatsapp_message Write

Send a transactional WhatsApp message.

Lua path
app.integrations.brevo.send_whatsapp_message
Full name
brevo.brevo_send_whatsapp_message
ParameterTypeRequiredDescription
No parameters.
send_whatsapp_template_approval Write

Send a WhatsApp template for approval.

Lua path
app.integrations.brevo.send_whatsapp_template_approval
Full name
brevo.brevo_send_whatsapp_template_for_approval
ParameterTypeRequiredDescription
No parameters.
update_attribute Write

Update a contact attribute.

Lua path
app.integrations.brevo.update_attribute
Full name
brevo.brevo_update_attribute
ParameterTypeRequiredDescription
No parameters.
update_category Write

Update an eCommerce category.

Lua path
app.integrations.brevo.update_category
Full name
brevo.brevo_update_category
ParameterTypeRequiredDescription
No parameters.
update_contact Write

Update a contact.

Lua path
app.integrations.brevo.update_contact
Full name
brevo.brevo_update_contact
ParameterTypeRequiredDescription
No parameters.
update_email_campaign Write

Update an email campaign.

Lua path
app.integrations.brevo.update_email_campaign
Full name
brevo.brevo_update_email_campaign
ParameterTypeRequiredDescription
No parameters.
update_external_feed Write

Update an external feed.

Lua path
app.integrations.brevo.update_external_feed
Full name
brevo.brevo_update_external_feed
ParameterTypeRequiredDescription
No parameters.
update_folder Write

Update a contact folder.

Lua path
app.integrations.brevo.update_folder
Full name
brevo.brevo_update_folder
ParameterTypeRequiredDescription
No parameters.
update_list Write

Update a contact list.

Lua path
app.integrations.brevo.update_list
Full name
brevo.brevo_update_list
ParameterTypeRequiredDescription
No parameters.
update_product Write

Update an eCommerce product.

Lua path
app.integrations.brevo.update_product
Full name
brevo.brevo_update_product
ParameterTypeRequiredDescription
No parameters.
update_sender Write

Update a sender.

Lua path
app.integrations.brevo.update_sender
Full name
brevo.brevo_update_sender
ParameterTypeRequiredDescription
No parameters.
update_sms_campaign Write

Update an SMS campaign.

Lua path
app.integrations.brevo.update_sms_campaign
Full name
brevo.brevo_update_sms_campaign
ParameterTypeRequiredDescription
No parameters.
update_smtp_template Write

Update an SMTP template.

Lua path
app.integrations.brevo.update_smtp_template
Full name
brevo.brevo_update_smtp_template
ParameterTypeRequiredDescription
No parameters.
update_webhook Write

Update a webhook.

Lua path
app.integrations.brevo.update_webhook
Full name
brevo.brevo_update_webhook
ParameterTypeRequiredDescription
No parameters.
update_whatsapp_campaign Write

Update a WhatsApp campaign.

Lua path
app.integrations.brevo.update_whatsapp_campaign
Full name
brevo.brevo_update_whatsapp_campaign
ParameterTypeRequiredDescription
No parameters.
upload_email_campaign_image Write

Upload an image for email campaigns.

Lua path
app.integrations.brevo.upload_email_campaign_image
Full name
brevo.brevo_upload_email_campaign_image
ParameterTypeRequiredDescription
No parameters.