MailSlurpClient::WebhookDto

Properties

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]
phone_id	String	The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set	[optional]
inbox_id	String	The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set	[optional]
request_body_template	String	Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload.	[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	Webhook trigger event name	[optional]
request_headers	WebhookHeaders		[optional]

Code Sample

require 'MailSlurpClient'

instance = MailSlurpClient::WebhookDto.new(id: null,
                                 user_id: null,
                                 basic_auth: null,
                                 name: null,
                                 phone_id: null,
                                 inbox_id: null,
                                 request_body_template: null,
                                 url: null,
                                 method: null,
                                 payload_json_schema: null,
                                 created_at: null,
                                 updated_at: null,
                                 event_name: null,
                                 request_headers: null)