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

Enum: MethodEnum

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

Enum: EventNameEnum

NameValue
EMAIL_RECEIVED“EMAIL_RECEIVED”
NEW_EMAIL“NEW_EMAIL”
NEW_CONTACT“NEW_CONTACT”
NEW_ATTACHMENT“NEW_ATTACHMENT”
EMAIL_OPENED“EMAIL_OPENED”
EMAIL_READ“EMAIL_READ”