MailSlurp JS

Globals / WebhookDto

Namespace: WebhookDto

export

namespace WebhookDto

Index

Enumerations

Properties

Properties

basicAuth

• Optional basicAuth: boolean

Defined in src/generated/api.ts:5637

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

• Optional createdAt: Date

Defined in src/generated/api.ts:5643

When the webhook was created

memberof WebhookDto

eventName

• Optional eventName: EventNameEnum

Defined in src/generated/api.ts:5649

memberof WebhookDto

id

• Optional id: string

Defined in src/generated/api.ts:5655

ID of the Webhook

memberof WebhookDto

inboxId

• Optional inboxId: string

Defined in src/generated/api.ts:5661

The inbox that the Webhook will be triggered by

memberof WebhookDto

method

• Optional method: MethodEnum

Defined in src/generated/api.ts:5667

HTTP method that your server endpoint must listen for

memberof WebhookDto

name

• Optional name: string

Defined in src/generated/api.ts:5673

Name of the webhook

memberof WebhookDto

payloadJsonSchema

• Optional payloadJsonSchema: string

Defined in src/generated/api.ts:5679

JSON Schema for the payload that will be sent to your URL via the HTTP method described.

memberof WebhookDto

updatedAt

• updatedAt: Date

Defined in src/generated/api.ts:5685

memberof WebhookDto

url

• Optional url: string

Defined in src/generated/api.ts:5691

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

• Optional userId: string

Defined in src/generated/api.ts:5697

User ID of the Webhook

memberof WebhookDto