Skip to content

Latest commit

 

History

History
39 lines (32 loc) · 2.06 KB

UpdateWebhook.md

File metadata and controls

39 lines (32 loc) · 2.06 KB

UpdateWebhook

Properties

Name Type Description Notes
url String URL of the webhook [optional]
description String Description of the webhook [optional]
events List<EventsEnum> - 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` [optional]
domain String Inbound domain of webhook, used in case of event type `inbound` [optional]
batched Boolean To send batched webhooks [optional]
auth GetWebhookAuth [optional]
headers List<GetWebhookHeaders> Custom headers to be send with webhooks [optional]

Enum: List<EventsEnum>

Name Value
SENT "sent"
HARDBOUNCE "hardBounce"
SOFTBOUNCE "softBounce"
BLOCKED "blocked"
SPAM "spam"
DELIVERED "delivered"
REQUEST "request"
CLICK "click"
INVALID "invalid"
DEFERRED "deferred"
OPENED "opened"
UNIQUEOPENED "uniqueOpened"
UNSUBSCRIBED "unsubscribed"
LISTADDITION "listAddition"
CONTACTUPDATED "contactUpdated"
CONTACTDELETED "contactDeleted"
INBOUNDEMAILPROCESSED "inboundEmailProcessed"