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://java.api.mailslurp.com/schemas/webhook-payload for the payload schema.
Properties
Name | Type | Description | Notes |
id | UUID | ID of the Webhook | |
userId | UUID | User ID of the Webhook | |
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. | |
name | String | Name of the webhook | [optional] |
phoneId | UUID | The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set | [optional] |
inboxId | UUID | The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set | [optional] |
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. | [optional] |
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. | |
method | MethodEnum | HTTP method that your server endpoint must listen for | |
payloadJsonSchema | String | Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method | |
createdAt | OffsetDateTime | When the webhook was created | |
updatedAt | OffsetDateTime | | |
eventName | EventNameEnum | Webhook trigger event name | [optional] |
requestHeaders | WebhookHeaders | | [optional] |
Enum: MethodEnum
Name | Value |
GET | "GET" |
HEAD | "HEAD" |
POST | "POST" |
PUT | "PUT" |
PATCH | "PATCH" |
DELETE | "DELETE" |
OPTIONS | "OPTIONS" |
TRACE | "TRACE" |
Enum: EventNameEnum
Name | Value |
EMAIL_RECEIVED | "EMAIL_RECEIVED" |
NEW_EMAIL | "NEW_EMAIL" |
NEW_CONTACT | "NEW_CONTACT" |
NEW_ATTACHMENT | "NEW_ATTACHMENT" |
EMAIL_OPENED | "EMAIL_OPENED" |
EMAIL_READ | "EMAIL_READ" |
DELIVERY_STATUS | "DELIVERY_STATUS" |
BOUNCE | "BOUNCE" |
BOUNCE_RECIPIENT | "BOUNCE_RECIPIENT" |
NEW_SMS | "NEW_SMS" |