Skip to content



Name Type Description Notes
id String ID of the Webhook
user_id String User ID of the Webhook
basic_auth Boolean 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]
inbox_id String The inbox that the Webhook will be triggered by. If null then webhook triggered at account level [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
payload_json_schema String Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method
created_at DateTime When the webhook was created
updated_at DateTime
event_name String [optional]

Code Sample

require 'MailSlurpClient'

instance = null,
                                 user_id: null,
                                 basic_auth: null,
                                 name: null,
                                 inbox_id: null,
                                 url: null,
                                 method: null,
                                 payload_json_schema: null,
                                 created_at: null,
                                 updated_at: null,
                                 event_name: null)