mailslurp.Model.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
BasicAuthboolDoes 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]
CreatedAtDateTimeWhen the webhook was created[optional]
EventNamestring[optional]
IdGuidID of the Webhook[optional]
InboxIdGuidThe inbox that the Webhook will be triggered by[optional]
MethodstringHTTP method that your server endpoint must listen for[optional]
NamestringName of the webhook[optional]
PayloadJsonSchemastringDeprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method[optional]
UpdatedAtDateTime
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]
UserIdGuidUser ID of the Webhook[optional]

[Back to Model list] [Back to API list] [Back to ]