WebhookDto
Properties
Name | Type | Description | Notes |
---|---|---|---|
id | java.util.UUID | ID of the Webhook | |
userId | java.util.UUID | User ID of the Webhook | |
basicAuth | kotlin.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. | |
url | kotlin.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. | |
method | inline | HTTP method that your server endpoint must listen for | |
payloadJsonSchema | kotlin.String | Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method | |
createdAt | java.time.OffsetDateTime | When the webhook was created | |
updatedAt | java.time.OffsetDateTime | ||
name | kotlin.String | Name of the webhook | [optional] |
inboxId | java.util.UUID | The inbox that the Webhook will be triggered by. If null then webhook triggered at account level | [optional] |
eventName | inline | [optional] |
Enum: method
Name | Value |
---|---|
method | GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE |
Enum: eventName
Name | Value |
---|---|
eventName | EMAIL_RECEIVED, NEW_EMAIL, NEW_CONTACT, NEW_ATTACHMENT, EMAIL_OPENED, EMAIL_READ, BOUNCE, BOUNCE_RECIPIENT |