18 lines
1.6 KiB
Markdown
18 lines
1.6 KiB
Markdown
|
# CreateWebhook
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------ | ------------- | ------------- | -------------
|
||
|
|
**url** | **string** | URL of the webhook |
|
||
|
|
**description** | **string** | Description of the webhook | [optional]
|
||
|
|
**events** | **string[]** | - 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` |
|
||
|
|
**type** | **string** | Type of the webhook | [optional] [default to 'transactional']
|
||
|
|
**domain** | **string** | Inbound domain of webhook, required in case of event type `inbound` | [optional]
|
||
|
|
**batched** | **bool** | To send batched webhooks | [optional]
|
||
|
|
**auth** | [**\Brevo\Client\Model\GetWebhookAuth**](GetWebhookAuth.md) | | [optional]
|
||
|
|
**headers** | [**\Brevo\Client\Model\GetWebhookHeaders[]**](GetWebhookHeaders.md) | Custom headers to be send with webhooks | [optional]
|
||
|
|
|
||
|
|
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||
|
|
|
||
|
|
|