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://api.mailslurp.com/schemas/webhook-payload for the payload schema.

Properties

NameTypeDescriptionNotes
basicAuthBooleanDoes 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.[optional]
createdAtOffsetDateTimeWhen the webhook was created[optional]
eventNameEventNameEnum[optional]
idUUIDID of the Webhook[optional]
inboxIdUUIDThe inbox that the Webhook will be triggered by[optional]
methodMethodEnumHTTP method that your server endpoint must listen for[optional]
nameStringName of the webhook[optional]
payloadJsonSchemaStringJSON Schema for the payload that will be sent to your URL via the HTTP method described.[optional]
updatedAtOffsetDateTime
urlStringURL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.[optional]
userIdUUIDUser ID of the Webhook[optional]

Enum: EventNameEnum

NameValue
EMAIL_RECEIVED“EMAIL_RECEIVED”
NEW_EMAIL“NEW_EMAIL”
NEW_CONTACT“NEW_CONTACT”
NEW_ATTACHMENT“NEW_ATTACHMENT”

Enum: MethodEnum

NameValue
GET“GET”
HEAD“HEAD”
POST“POST”
PUT“PUT”
PATCH“PATCH”
DELETE“DELETE”
OPTIONS“OPTIONS”
TRACE“TRACE”