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 webhook's event is triggered. Webhooks are great for processing many inbound emails and responding to other events at scale. Customize the payload sent to your endpoint by setting the requestBodyTemplate property to a string with moustache style variables. Property names from the standard payload model for the given event are available as variables.


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.

memberof CreateWebhookOptions


Optional includeHeaders: WebhookHeaders

memberof CreateWebhookOptions


Optional name: string

Optional name for the webhook

memberof CreateWebhookOptions


Optional requestBodyTemplate: string

Template for the JSON body of the webhook request that will be sent to your server. Use Moustache style {{variableName}} templating to use parts of the standard webhook payload for the given event.

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. See for event payload documentation.

memberof CreateWebhookOptions