/brevo-settings | Type: Application | PCID required: Yes
Tools
brevo_settings_authenticate_domain
Authenticate a sender domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domainName | string | Yes | — | Domain name |
brevo_settings_create_domain
Create a new sender domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Domain name to be added |
brevo_settings_create_external_feed
Create external feed Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authType | string | No | — | Authentication type for accessing the feed |
cache | boolean | No | — | Whether to cache the feed response |
headers | object[] | No | — | Custom HTTP headers for the feed request |
maxRetries | integer | No | — | Maximum number of retry attempts for failed requests |
name | string | Yes | — | Name of the feed |
password | string | No | — | Password for basic authentication (required if authType is ‘basic’) |
token | string | No | — | Token for token-based authentication (required if authType is ‘token’) |
url | string | Yes | — | URL of the external data source |
username | string | No | — | Username for basic authentication (required if authType is ‘basic’) |
brevo_settings_create_webhook
Create a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
auth | object | No | — | Add authentication on webhook url |
batched | boolean | No | — | To send batched webhooks |
channel | string | No | — | Channel of the webhook |
description | string | No | — | Description of the webhook |
domain | string | No | — | Inbound domain of webhook, required in case of event type inbound |
events | string[] | No | — | Events triggering the webhook. Required for transactional and marketing types, optional for inbound type (defaults to inboundEmailProcessed). Possible values for Transactional type webhook: sent OR request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed. Possible values for Marketing type webhook: spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition, delivered, contactUpdated & contactDeleted. Possible values for Inbound type webhook: inboundEmailProcessed. |
headers | object[] | No | — | Custom headers to be send with webhooks |
type | string | No | — | Type of the webhook |
url | string | Yes | — | URL of the webhook |
brevo_settings_delete_domain
Delete a sender domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domainName | string | Yes | — | Domain name |
brevo_settings_delete_external_feed
Delete external feed Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | string | Yes | — | UUID of the feed to delete |
brevo_settings_delete_webhook
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | integer | Yes | — | Id of the webhook |
brevo_settings_export_webhooks_history
Export webhook event history as CSV file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
days | integer | No | — | Number of days in the past including today (positive integer). Not compatible with ‘startDate’ and ‘endDate’ |
email | string | No | — | Filter the history for a specific email |
endDate | string | No | — | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate |
event | string | Yes | — | Filter the history for a specific event type |
messageId | string | No | — | Filter the history for a specific message id. Applicable only for transactional webhooks. |
notifyURL | string | Yes | — | Webhook URL to receive CSV file link |
sort | string | No | — | Sorting order of records (asc or desc) |
startDate | string | No | — | Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate |
type | string | Yes | — | Filter the history based on webhook type |
webhookId | integer | No | — | Filter the history for a specific webhook id |
brevo_settings_get_account
Get account detailsbrevo_settings_get_all_external_feeds
Get all external feeds Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
search | string | No | — | Can be used to filter records by search keyword on feed name |
startDate | string | No | — | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. |
endDate | string | No | — | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. |
sort | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. |
authType | string | No | — | Filter the records by authType of the feed. |
limit | integer | No | — | Number of documents returned per page. |
offset | integer | No | — | Index of the first document on the page. |
brevo_settings_get_domain_configuration
Get a sender domain configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domainName | string | Yes | — | Domain name |
brevo_settings_get_domains
Get the list of all sender domainsbrevo_settings_get_external_feed_by_uuid
Get external feed details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | string | Yes | — | UUID of the feed to fetch |
brevo_settings_get_process
Get process details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
processId | integer | Yes | — | Id of the process |
brevo_settings_get_processes
Get background processes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number limitation for the result returned |
offset | integer | No | — | Beginning point in the list to retrieve from. |
sort | string | No | — | Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed |
brevo_settings_get_webhook
Get a webhook details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | integer | Yes | — | Id of the webhook |
brevo_settings_get_webhooks
Get all webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | No | — | Filter on webhook type |
sort | string | No | — | Sort the results in the ascending/descending order of webhook creation |
brevo_settings_update_external_feed
Update external feed Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uuid | string | Yes | — | UUID of the feed to update |
authType | string | No | — | Authentication type for accessing the feed |
cache | boolean | No | — | Whether to cache the feed response |
headers | object[] | No | — | Custom HTTP headers for the feed request |
maxRetries | integer | No | — | Maximum number of retry attempts for failed requests |
name | string | No | — | Name of the feed |
password | string | No | — | Password for basic authentication |
token | string | No | — | Token for token-based authentication |
url | string | No | — | URL of the external data source |
username | string | No | — | Username for basic authentication |
brevo_settings_update_webhook
Update a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | integer | Yes | — | Id of the webhook |
auth | object | No | — | Add authentication on webhook url |
batched | boolean | No | — | To send batched webhooks |
description | string | No | — | Description of the webhook |
domain | string | No | — | Inbound domain of webhook, used in case of event type inbound |
events | string[] | No | — | - Events triggering the webhook. Possible values for Transactional type webhook: #### sent OR request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed - Possible values for Marketing type webhook: #### spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered - Possible values for Inbound type webhook: #### inboundEmailProcessed #### reply |
headers | object[] | No | — | Custom headers to be send with webhooks |
url | string | No | — | URL of the webhook |

