Skip to content

Latest commit

 

History

History
66 lines (33 loc) · 1.8 KB

CreateWebhook.md

File metadata and controls

66 lines (33 loc) · 1.8 KB

SibApiV3Sdk.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]

Enum: [EventsEnum]

  • sent (value: "sent")

  • hardBounce (value: "hardBounce")

  • softBounce (value: "softBounce")

  • blocked (value: "blocked")

  • spam (value: "spam")

  • delivered (value: "delivered")

  • request (value: "request")

  • click (value: "click")

  • invalid (value: "invalid")

  • deferred (value: "deferred")

  • opened (value: "opened")

  • uniqueOpened (value: "uniqueOpened")

  • unsubscribed (value: "unsubscribed")

  • listAddition (value: "listAddition")

  • contactUpdated (value: "contactUpdated")

  • contactDeleted (value: "contactDeleted")

  • inboundEmailProcessed (value: "inboundEmailProcessed")

Enum: TypeEnum

  • transactional (value: "transactional")

  • marketing (value: "marketing")

  • inbound (value: "inbound")