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

Hierarchy

  • WebhookDto

Properties

basicAuth createdAt eventName? id ignoreInsecureSslCertificates? inboxId? method name? payloadJsonSchema phoneId? requestBodyTemplate? requestHeaders? updatedAt url useStaticIpRange? userId

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

Optional eventName

eventName?: WebhookDtoEventNameEnum

Webhook trigger event name

Memberof

WebhookDto

id

id: string

ID of the Webhook

Memberof

WebhookDto

Optional ignoreInsecureSslCertificates

ignoreInsecureSslCertificates?: boolean

Should notifier ignore insecure SSL certificates

Memberof

WebhookDto

Optional inboxId

inboxId?: string

The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set

Memberof

WebhookDto

method

method: WebhookDtoMethodEnum

HTTP method that your server endpoint must listen for

Memberof

WebhookDto

Optional name

name?: string

Name of the webhook

Memberof

WebhookDto

payloadJsonSchema

payloadJsonSchema: string

Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method

Memberof

WebhookDto

Optional phoneId

phoneId?: string

The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set

Memberof

WebhookDto

Optional requestBodyTemplate

requestBodyTemplate?: string

Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload.

Memberof

WebhookDto

Optional requestHeaders

requestHeaders?: WebhookHeaders

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

Optional useStaticIpRange

useStaticIpRange?: boolean

Should notifier use static IP range when sending webhook payload

Memberof

WebhookDto

userId

userId: string

User ID of the Webhook

Memberof

WebhookDto

Settings

Member Visibility

Theme