WebhookDto

Properties

NameTypeDescriptionNotes
updatedAtjava.time.OffsetDateTime
basicAuthkotlin.BooleanDoes 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]
createdAtjava.time.OffsetDateTimeWhen the webhook was created[optional]
eventNameinline[optional]
idjava.util.UUIDID of the Webhook[optional]
inboxIdjava.util.UUIDThe inbox that the Webhook will be triggered by[optional]
methodinlineHTTP method that your server endpoint must listen for[optional]
namekotlin.StringName of the webhook[optional]
payloadJsonSchemakotlin.StringJSON Schema for the payload that will be sent to your URL via the HTTP method described.[optional]
urlkotlin.StringURL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.[optional]
userIdjava.util.UUIDUser ID of the Webhook[optional]

Enum: eventName

NameValue
eventNameEMAIL_RECEIVED, NEW_EMAIL, NEW_CONTACT, NEW_ATTACHMENT

Enum: method

NameValue
methodGET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE