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
basic_authboolDoes 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]
created_atdatetimeWhen the webhook was created[optional]
event_namestr[optional]
idstrID of the Webhook[optional]
inbox_idstrThe inbox that the Webhook will be triggered by[optional]
methodstrHTTP method that your server endpoint must listen for[optional]
namestrName of the webhook[optional]
payload_json_schemastrJSON Schema for the payload that will be sent to your URL via the HTTP method described.[optional]
updated_atdatetime
urlstrURL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.[optional]
user_idstrUser ID of the Webhook[optional]

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