Skip to content

RestEWebhook.md

Latest commit

 

History

History
34 lines (28 loc) · 1.27 KB

RestEWebhook.md

File metadata and controls

34 lines (28 loc) · 1.27 KB

SendX::RestEWebhook

Properties

Name Type Description Notes
url String Webhook endpoint URL
enabled Boolean Whether webhook is enabled [default to true]
unsubscribed Boolean Trigger webhook when a contact unsubscribes [optional][default to false]
dropped Boolean Trigger webhook when an email is dropped [optional][default to false]
bounced Boolean Trigger webhook when an email bounces [optional][default to false]
marked_spam Boolean Trigger webhook when an email is marked as spam [optional][default to false]
clicked Boolean Trigger webhook when a link in the email is clicked [optional][default to false]
opened Boolean Trigger webhook when an email is opened [optional][default to false]
contact_created Boolean Trigger webhook when a new contact is created [optional][default to false]

Example

require 'sendx-ruby-sdk'

instance = SendX::RestEWebhook.new(
  url: https://api.example.com/webhooks/sendx,
  enabled: null,
  unsubscribed: null,
  dropped: null,
  bounced: null,
  marked_spam: null,
  clicked: null,
  opened: null,
  contact_created: null
)