Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 2.03 KB

CreateWebhook.md

File metadata and controls

46 lines (37 loc) · 2.03 KB

CreateWebhook

Properties

Name Type Description Notes
url String URL of the webhook
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`
type TypeEnum Type of the webhook [optional]
domain String Inbound domain of webhook, required in case of event type `inbound` [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"

Enum: TypeEnum

Name Value
TRANSACTIONAL "transactional"
MARKETING "marketing"
INBOUND "inbound"