> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# brevo-settings
> Brevo Settings
**Server path:** `/brevo-settings` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------- | ---------------------------------------- |
| [`brevo_settings_authenticate_domain`](#brevo_settings_authenticate_domain) | Authenticate a sender domain |
| [`brevo_settings_create_domain`](#brevo_settings_create_domain) | Create a new sender domain |
| [`brevo_settings_create_external_feed`](#brevo_settings_create_external_feed) | Create external feed |
| [`brevo_settings_create_webhook`](#brevo_settings_create_webhook) | Create a webhook |
| [`brevo_settings_delete_domain`](#brevo_settings_delete_domain) | Delete a sender domain |
| [`brevo_settings_delete_external_feed`](#brevo_settings_delete_external_feed) | Delete external feed |
| [`brevo_settings_delete_webhook`](#brevo_settings_delete_webhook) | Delete a webhook |
| [`brevo_settings_export_webhooks_history`](#brevo_settings_export_webhooks_history) | Export webhook event history as CSV file |
| [`brevo_settings_get_account`](#brevo_settings_get_account) | Get account details |
| [`brevo_settings_get_all_external_feeds`](#brevo_settings_get_all_external_feeds) | Get all external feeds |
| [`brevo_settings_get_domain_configuration`](#brevo_settings_get_domain_configuration) | Get a sender domain configuration |
| [`brevo_settings_get_domains`](#brevo_settings_get_domains) | Get the list of all sender domains |
| [`brevo_settings_get_external_feed_by_uuid`](#brevo_settings_get_external_feed_by_uuid) | Get external feed details |
| [`brevo_settings_get_process`](#brevo_settings_get_process) | Get process details |
| [`brevo_settings_get_processes`](#brevo_settings_get_processes) | Get background processes |
| [`brevo_settings_get_webhook`](#brevo_settings_get_webhook) | Get a webhook details |
| [`brevo_settings_get_webhooks`](#brevo_settings_get_webhooks) | Get all webhooks |
| [`brevo_settings_update_external_feed`](#brevo_settings_update_external_feed) | Update external feed |
| [`brevo_settings_update_webhook`](#brevo_settings_update_webhook) | Update a webhook |
***
## brevo\_settings\_authenticate\_domain
Authenticate a sender domain
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `domainName` | string | Yes | — | Domain name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"domainName": {
"type": "string",
"description": "Domain name"
}
},
"required": [
"PCID",
"domainName"
]
}
```
***
## brevo\_settings\_create\_domain
Create a new sender domain
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------- |
| `name` | string | Yes | — | Domain name to be added |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Domain name to be added"
}
},
"required": [
"PCID",
"name"
]
}
```
***
## 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') |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authType": {
"type": "string",
"description": "Authentication type for accessing the feed",
"enum": [
"basic",
"token",
"noAuth"
]
},
"cache": {
"type": "boolean",
"description": "Whether to cache the feed response"
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Header name"
},
"value": {
"type": "string",
"description": "Header value"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom HTTP headers for the feed request"
},
"maxRetries": {
"type": "integer",
"description": "Maximum number of retry attempts for failed requests"
},
"name": {
"type": "string",
"description": "Name of the feed"
},
"password": {
"type": "string",
"description": "Password for basic authentication (required if authType is 'basic')"
},
"token": {
"type": "string",
"description": "Token for token-based authentication (required if authType is 'token')"
},
"url": {
"type": "string",
"description": "URL of the external data source"
},
"username": {
"type": "string",
"description": "Username for basic authentication (required if authType is 'basic')"
}
},
"required": [
"PCID",
"name",
"url"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"auth": {
"type": "object",
"description": "Add authentication on webhook url",
"properties": {
"token": {
"type": "string",
"description": "Webhook authentication token"
},
"type": {
"type": "string",
"description": "Type of authentication"
}
}
},
"batched": {
"type": "boolean",
"description": "To send batched webhooks"
},
"channel": {
"type": "string",
"description": "Channel of the webhook",
"enum": [
"email",
"sms"
]
},
"description": {
"type": "string",
"description": "Description of the webhook"
},
"domain": {
"type": "string",
"description": "Inbound domain of webhook, required in case of event type `inbound`"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"sent",
"hardBounce",
"softBounce",
"blocked",
"spam",
"delivered",
"request",
"click",
"invalid",
"deferred",
"opened",
"uniqueOpened",
"unsubscribed",
"listAddition",
"contactUpdated",
"contactDeleted",
"inboundEmailProcessed",
"reply"
]
},
"description": "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": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Header key name"
},
"value": {
"type": "string",
"description": "Header value"
}
}
},
"description": "Custom headers to be send with webhooks"
},
"type": {
"type": "string",
"description": "Type of the webhook",
"enum": [
"transactional",
"marketing",
"inbound"
]
},
"url": {
"type": "string",
"description": "URL of the webhook"
}
},
"required": [
"PCID",
"url"
]
}
```
***
## brevo\_settings\_delete\_domain
Delete a sender domain
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `domainName` | string | Yes | — | Domain name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"domainName": {
"type": "string",
"description": "Domain name"
}
},
"required": [
"PCID",
"domainName"
]
}
```
***
## brevo\_settings\_delete\_external\_feed
Delete external feed
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------- |
| `uuid` | string | Yes | — | UUID of the feed to delete |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "UUID of the feed to delete"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## brevo\_settings\_delete\_webhook
Delete a webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------------- |
| `webhookId` | integer | Yes | — | Id of the webhook |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhookId": {
"type": "integer",
"description": "Id of the webhook"
}
},
"required": [
"PCID",
"webhookId"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"days": {
"type": "integer",
"description": "Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_"
},
"email": {
"type": "string",
"description": "Filter the history for a specific email"
},
"endDate": {
"type": "string",
"description": "Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate"
},
"event": {
"type": "string",
"description": "Filter the history for a specific event type",
"enum": [
"invalid_parameter",
"missing_parameter",
"hardBounce",
"softBounce",
"delivered",
"spam",
"request",
"opened",
"click",
"invalid",
"deferred",
"blocked",
"unsubscribed",
"error",
"uniqueOpened",
"loadedByProxy",
"allEvents"
]
},
"messageId": {
"type": "string",
"description": "Filter the history for a specific message id. Applicable only for transactional webhooks."
},
"notifyURL": {
"type": "string",
"description": "Webhook URL to receive CSV file link"
},
"sort": {
"type": "string",
"description": "Sorting order of records (asc or desc)"
},
"startDate": {
"type": "string",
"description": "Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate"
},
"type": {
"type": "string",
"description": "Filter the history based on webhook type",
"enum": [
"transactional",
"marketing"
]
},
"webhookId": {
"type": "integer",
"description": "Filter the history for a specific webhook id"
}
},
"required": [
"PCID",
"event",
"notifyURL",
"type"
]
}
```
***
## brevo\_settings\_get\_account
Get account details
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## brevo\_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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"search": {
"type": "string",
"description": "Can be used to filter records by search keyword on feed name"
},
"startDate": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed.",
"enum": [
"asc",
"desc"
]
},
"authType": {
"type": "string",
"description": "Filter the records by `authType` of the feed.",
"enum": [
"basic",
"token",
"noAuth"
]
},
"limit": {
"type": "integer",
"description": "Number of documents returned per page."
},
"offset": {
"type": "integer",
"description": "Index of the first document on the page."
}
},
"required": [
"PCID"
]
}
```
***
## brevo\_settings\_get\_domain\_configuration
Get a sender domain configuration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `domainName` | string | Yes | — | Domain name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"domainName": {
"type": "string",
"description": "Domain name"
}
},
"required": [
"PCID",
"domainName"
]
}
```
***
## brevo\_settings\_get\_domains
Get the list of all sender domains
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## brevo\_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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "UUID of the feed to fetch"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## brevo\_settings\_get\_process
Get process details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------------- |
| `processId` | integer | Yes | — | Id of the process |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"processId": {
"type": "integer",
"description": "Id of the process"
}
},
"required": [
"PCID",
"processId"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number limitation for the result returned"
},
"offset": {
"type": "integer",
"description": "Beginning point in the list to retrieve from."
},
"sort": {
"type": "string",
"description": "Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"PCID"
]
}
```
***
## brevo\_settings\_get\_webhook
Get a webhook details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------------- |
| `webhookId` | integer | Yes | — | Id of the webhook |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhookId": {
"type": "integer",
"description": "Id of the webhook"
}
},
"required": [
"PCID",
"webhookId"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"type": {
"type": "string",
"description": "Filter on webhook type",
"enum": [
"marketing",
"transactional",
"inbound"
]
},
"sort": {
"type": "string",
"description": "Sort the results in the ascending/descending order of webhook creation",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"PCID"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uuid": {
"type": "string",
"description": "UUID of the feed to update"
},
"authType": {
"type": "string",
"description": "Authentication type for accessing the feed",
"enum": [
"basic",
"token",
"noAuth"
]
},
"cache": {
"type": "boolean",
"description": "Whether to cache the feed response"
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Header name"
},
"value": {
"type": "string",
"description": "Header value"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom HTTP headers for the feed request"
},
"maxRetries": {
"type": "integer",
"description": "Maximum number of retry attempts for failed requests"
},
"name": {
"type": "string",
"description": "Name of the feed"
},
"password": {
"type": "string",
"description": "Password for basic authentication"
},
"token": {
"type": "string",
"description": "Token for token-based authentication"
},
"url": {
"type": "string",
"description": "URL of the external data source"
},
"username": {
"type": "string",
"description": "Username for basic authentication"
}
},
"required": [
"PCID",
"uuid"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhookId": {
"type": "integer",
"description": "Id of the webhook"
},
"auth": {
"type": "object",
"description": "Add authentication on webhook url",
"properties": {
"token": {
"type": "string",
"description": "Webhook authentication token"
},
"type": {
"type": "string",
"description": "Type of authentication"
}
}
},
"batched": {
"type": "boolean",
"description": "To send batched webhooks"
},
"description": {
"type": "string",
"description": "Description of the webhook"
},
"domain": {
"type": "string",
"description": "Inbound domain of webhook, used in case of event type `inbound`"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"sent",
"hardBounce",
"softBounce",
"blocked",
"spam",
"delivered",
"request",
"click",
"invalid",
"deferred",
"opened",
"uniqueOpened",
"unsubscribed",
"listAddition",
"contactUpdated",
"contactDeleted",
"inboundEmailProcessed",
"reply"
]
},
"description": "- 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": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Header key name"
},
"value": {
"type": "string",
"description": "Header value"
}
}
},
"description": "Custom headers to be send with webhooks"
},
"url": {
"type": "string",
"description": "URL of the webhook"
}
},
"required": [
"PCID",
"webhookId"
]
}
```