Globals / WebhookDto
# Namespace: WebhookDto
export
namespace WebhookDto
# Index
# Enumerations
# Properties
# Properties
# basicAuth
• Optional basicAuth: boolean
Defined in src/generated/api.ts:2801 (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.
memberof WebhookDto
# createdAt
• Optional createdAt: Date
Defined in src/generated/api.ts:2807 (opens new window)
When the webhook was created
memberof WebhookDto
# id
• Optional id: string
Defined in src/generated/api.ts:2813 (opens new window)
ID of the Webhook
memberof WebhookDto
# inboxId
• Optional inboxId: string
Defined in src/generated/api.ts:2819 (opens new window)
The inbox that the Webhook will be triggered by
memberof WebhookDto
# method
• Optional method: MethodEnum
Defined in src/generated/api.ts:2825 (opens new window)
HTTP method that your server endpoint must listen for
memberof WebhookDto
# name
• Optional name: string
Defined in src/generated/api.ts:2831 (opens new window)
Name of the webhook
memberof WebhookDto
# payloadJsonSchema
• Optional payloadJsonSchema: string
Defined in src/generated/api.ts:2837 (opens new window)
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:2843 (opens new window)
memberof WebhookDto
# url
• Optional url: string
Defined in src/generated/api.ts:2849 (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.
memberof WebhookDto
