Skip to content

WebhookDto

Properties

Name Type Description Notes
_id UUID ID of the Webhook
userId UUID User ID of the Webhook
basicAuth Bool Does 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.
name String Name of the webhook [optional]
phoneId UUID The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set [optional]
inboxId UUID The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set [optional]
url String URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.
method String HTTP method that your server endpoint must listen for
payloadJsonSchema String Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method
createdAt Date When the webhook was created
updatedAt Date
eventName String Webhook trigger event name [optional]
requestHeaders WebhookHeaders [optional]

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