Properties

NameTypeDescriptionNotes
urlStringPublic URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. The default EMAIL_RECEIVED payload is described by https://api.mailslurp.com/schemas/webhook-payload. The other events, NEW_EMAIL, NEW_CONTACT, and NEW_ATTACHMENT are described by https://api.mailslurp.com/schemas/webhook-new-email-payload, https://api.mailslurp.com/schemas/webhook-new-contact-payload,https://api.mailslurp.com/schemas/webhook-new-attachment-payload respectively.
basic_authBasicAuthOptions[optional]
nameStringOptional name for the webhook[optional]
event_nameStringOptional webhook event name. Default is EMAIL_RECEIVED and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name. The other events are NEW_EMAIL, NEW_CONTACT, and NEW_ATTACHMENT and EMAIL_OPENED. EMAIL_OPENED requires the use of tracking pixels when sending. See the email tracking guide for more information.[optional]

Code Sample

require 'MailSlurpClient'

instance = MailSlurpClient::CreateWebhookOptions.new(url: null,
                                 basic_auth: null,
                                 name: null,
                                 event_name: null)