# Module: WebhookDto

export

namespace WebhookDto

# Properties

# Optional basicAuth

basicAuth? : boolean

Defined in src/generated/api.ts:2446 (opens new window)

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.

type {boolean}

memberof WebhookDto


# Optional createdAt

createdAt? : Date

Defined in src/generated/api.ts:2452 (opens new window)

When the webhook was created

type {Date}

memberof WebhookDto


# Optional id

id? : string

Defined in src/generated/api.ts:2458 (opens new window)

ID of the Webhook

type {string}

memberof WebhookDto


# Optional inboxId

inboxId? : string

Defined in src/generated/api.ts:2464 (opens new window)

The inbox that the Webhook will be triggered by

type {string}

memberof WebhookDto


# Optional method

method? : MethodEnum

Defined in src/generated/api.ts:2470 (opens new window)

HTTP method that your server endpoint must listen for

type {string}

memberof WebhookDto


# Optional name

name? : string

Defined in src/generated/api.ts:2476 (opens new window)

Name of the webhook

type {string}

memberof WebhookDto


# Optional payloadJsonSchema

payloadJsonSchema? : string

Defined in src/generated/api.ts:2482 (opens new window)

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

type {string}

memberof WebhookDto


# updatedAt

updatedAt: Date

Defined in src/generated/api.ts:2488 (opens new window)

type {Date}

memberof WebhookDto


# Optional url

url? : string

Defined in src/generated/api.ts:2494 (opens new window)

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

type {string}

memberof WebhookDto