Skip to content

Interface: CreateWebhookOptions

Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the inbox receives an email. Webhooks are great for processing many inbound emails.


interface CreateWebhookOptions

Table of contents




Optional basicAuth: BasicAuthOptions

memberof CreateWebhookOptions


Optional eventName: CreateWebhookOptionsEventNameEnum

Optional 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.

memberof CreateWebhookOptions


Optional name: string

Optional name for the webhook

memberof CreateWebhookOptions


url: string

Public 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 The other events, NEW_EMAIL, NEW_CONTACT, and NEW_ATTACHMENT are described by,, respectively.

memberof CreateWebhookOptions