Name | Type | Description | Notes |
---|---|---|---|
url | String | URL of the webhook | |
description | String | Description of the webhook | [optional] |
events | Array<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 | BOOLEAN | To send batched webhooks | [optional] |
auth | GetWebhookAuth | [optional] | |
headers | Array<GetWebhookHeaders> | Custom headers to be send with webhooks | [optional] |