Skip to main content
Server path: /brevo-settings | Type: Application | PCID required: Yes

Tools

ToolDescription
brevo_settings_authenticate_domainAuthenticate a sender domain
brevo_settings_create_domainCreate a new sender domain
brevo_settings_create_external_feedCreate external feed
brevo_settings_create_webhookCreate a webhook
brevo_settings_delete_domainDelete a sender domain
brevo_settings_delete_external_feedDelete external feed
brevo_settings_delete_webhookDelete a webhook
brevo_settings_export_webhooks_historyExport webhook event history as CSV file
brevo_settings_get_accountGet account details
brevo_settings_get_all_external_feedsGet all external feeds
brevo_settings_get_domain_configurationGet a sender domain configuration
brevo_settings_get_domainsGet the list of all sender domains
brevo_settings_get_external_feed_by_uuidGet external feed details
brevo_settings_get_processGet process details
brevo_settings_get_processesGet background processes
brevo_settings_get_webhookGet a webhook details
brevo_settings_get_webhooksGet all webhooks
brevo_settings_update_external_feedUpdate external feed
brevo_settings_update_webhookUpdate a webhook

brevo_settings_authenticate_domain

Authenticate a sender domain Parameters:
ParameterTypeRequiredDefaultDescription
domainNamestringYesDomain name

brevo_settings_create_domain

Create a new sender domain Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesDomain name to be added

brevo_settings_create_external_feed

Create external feed Parameters:
ParameterTypeRequiredDefaultDescription
authTypestringNoAuthentication type for accessing the feed
cachebooleanNoWhether to cache the feed response
headersobject[]NoCustom HTTP headers for the feed request
maxRetriesintegerNoMaximum number of retry attempts for failed requests
namestringYesName of the feed
passwordstringNoPassword for basic authentication (required if authType is ‘basic’)
tokenstringNoToken for token-based authentication (required if authType is ‘token’)
urlstringYesURL of the external data source
usernamestringNoUsername for basic authentication (required if authType is ‘basic’)

brevo_settings_create_webhook

Create a webhook Parameters:
ParameterTypeRequiredDefaultDescription
authobjectNoAdd authentication on webhook url
batchedbooleanNoTo send batched webhooks
channelstringNoChannel of the webhook
descriptionstringNoDescription of the webhook
domainstringNoInbound domain of webhook, required in case of event type inbound
eventsstring[]NoEvents 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.
headersobject[]NoCustom headers to be send with webhooks
typestringNoType of the webhook
urlstringYesURL of the webhook

brevo_settings_delete_domain

Delete a sender domain Parameters:
ParameterTypeRequiredDefaultDescription
domainNamestringYesDomain name

brevo_settings_delete_external_feed

Delete external feed Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesUUID of the feed to delete

brevo_settings_delete_webhook

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdintegerYesId of the webhook

brevo_settings_export_webhooks_history

Export webhook event history as CSV file Parameters:
ParameterTypeRequiredDefaultDescription
daysintegerNoNumber of days in the past including today (positive integer). Not compatible with ‘startDate’ and ‘endDate’
emailstringNoFilter the history for a specific email
endDatestringNoMandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
eventstringYesFilter the history for a specific event type
messageIdstringNoFilter the history for a specific message id. Applicable only for transactional webhooks.
notifyURLstringYesWebhook URL to receive CSV file link
sortstringNoSorting order of records (asc or desc)
startDatestringNoMandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate
typestringYesFilter the history based on webhook type
webhookIdintegerNoFilter the history for a specific webhook id

brevo_settings_get_account

Get account details

brevo_settings_get_all_external_feeds

Get all external feeds Parameters:
ParameterTypeRequiredDefaultDescription
searchstringNoCan be used to filter records by search keyword on feed name
startDatestringNoMandatory 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.
endDatestringNoMandatory 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.
sortstringNoSort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed.
authTypestringNoFilter the records by authType of the feed.
limitintegerNoNumber of documents returned per page.
offsetintegerNoIndex of the first document on the page.

brevo_settings_get_domain_configuration

Get a sender domain configuration Parameters:
ParameterTypeRequiredDefaultDescription
domainNamestringYesDomain name

brevo_settings_get_domains

Get the list of all sender domains

brevo_settings_get_external_feed_by_uuid

Get external feed details Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesUUID of the feed to fetch

brevo_settings_get_process

Get process details Parameters:
ParameterTypeRequiredDefaultDescription
processIdintegerYesId of the process

brevo_settings_get_processes

Get background processes Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber limitation for the result returned
offsetintegerNoBeginning point in the list to retrieve from.
sortstringNoSort 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:
ParameterTypeRequiredDefaultDescription
webhookIdintegerYesId of the webhook

brevo_settings_get_webhooks

Get all webhooks Parameters:
ParameterTypeRequiredDefaultDescription
typestringNoFilter on webhook type
sortstringNoSort the results in the ascending/descending order of webhook creation

brevo_settings_update_external_feed

Update external feed Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesUUID of the feed to update
authTypestringNoAuthentication type for accessing the feed
cachebooleanNoWhether to cache the feed response
headersobject[]NoCustom HTTP headers for the feed request
maxRetriesintegerNoMaximum number of retry attempts for failed requests
namestringNoName of the feed
passwordstringNoPassword for basic authentication
tokenstringNoToken for token-based authentication
urlstringNoURL of the external data source
usernamestringNoUsername for basic authentication

brevo_settings_update_webhook

Update a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdintegerYesId of the webhook
authobjectNoAdd authentication on webhook url
batchedbooleanNoTo send batched webhooks
descriptionstringNoDescription of the webhook
domainstringNoInbound domain of webhook, used in case of event type inbound
eventsstring[]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
headersobject[]NoCustom headers to be send with webhooks
urlstringNoURL of the webhook