Skip to content

CreateWebhookOptions

Properties

Name Type Description Notes
Url String Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. See docs.mailslurp.com/webhooks for event payload documentation.
BasicAuth BasicAuthOptions [optional]
Name String Optional name for the webhook [optional]
EventName String Optional webhook event name. Default is EMAIL_RECEIVED and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name. [optional]
IncludeHeaders WebhookHeaders [optional]
RequestBodyTemplate String Template for the JSON body of the webhook request that will be sent to your server. Use Moustache style {{variableName}} templating to use parts of the standard webhook payload for the given event. [optional]

Examples

  • Prepare the resource
$CreateWebhookOptions = Initialize-maislurp-client-powershellCreateWebhookOptions  -Url null `
 -BasicAuth null `
 -Name null `
 -EventName null `
 -IncludeHeaders null `
 -RequestBodyTemplate null
  • Convert the resource to JSON
$CreateWebhookOptions | ConvertTo-JSON

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