Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.71 KB

UpdateWebhook.md

File metadata and controls

30 lines (24 loc) · 1.71 KB

Brevo::UpdateWebhook

Properties

Name Type Description Notes
url String URL of the webhook [optional]
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` [optional]
domain String Inbound domain of webhook, used in case of event type `inbound` [optional]
batched Boolean Batching configuration of the webhook, we send batched webhooks if its true [optional]
auth Object Authentication header to be send with the webhook requests [optional]
headers Array<Object> [optional]

Example

require 'brevo'

instance = Brevo::UpdateWebhook.new(
  url: http://requestb.in/173lyyx1,
  description: Webhook triggered on contact hardbounce,
  events: null,
  domain: example.com,
  batched: true,
  auth: {&quot;type&quot;:&quot;bearer&quot;,&quot;token&quot;:&quot;test-auth-token1234&quot;},
  headers: null
)