Skip to content

Interface: WebhookDto

Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox. A webhook entity should have a URL that points to your server. Your server should accept HTTP/S POST requests and return a success 200. MailSlurp will retry your webhooks if they fail. See https://api.mailslurp.com/schemas/webhook-payload for the payload schema.

export

interface WebhookDto

Table of contents

Properties

Properties

basicAuth

basicAuth: boolean

Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself.

memberof WebhookDto


createdAt

createdAt: Date

When the webhook was created

memberof WebhookDto


eventName

Optional eventName: WebhookDtoEventNameEnum

memberof WebhookDto


id

id: string

ID of the Webhook

memberof WebhookDto


inboxId

Optional inboxId: string

The inbox that the Webhook will be triggered by. If null then webhook triggered at account level

memberof WebhookDto


method

method: WebhookDtoMethodEnum

HTTP method that your server endpoint must listen for

memberof WebhookDto


name

Optional name: string

Name of the webhook

memberof WebhookDto


payloadJsonSchema

payloadJsonSchema: string

Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method

memberof WebhookDto


updatedAt

updatedAt: Date

memberof WebhookDto


url

url: string

URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.

memberof WebhookDto


userId

userId: string

User ID of the Webhook

memberof WebhookDto