WebhookDto

Properties

NameTypeDescriptionNotes
BasicAuthBooleanDoes 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]
CreatedAtSystem.DateTimeWhen the webhook was created[optional]
EventNameString[optional]
IdStringID of the Webhook[optional]
InboxIdStringThe inbox that the Webhook will be triggered by[optional]
MethodStringHTTP method that your server endpoint must listen for[optional]
NameStringName of the webhook[optional]
PayloadJsonSchemaStringDeprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method[optional]
UpdatedAtSystem.DateTime
UrlStringURL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema.[optional]
UserIdStringUser ID of the Webhook[optional]

Examples

  • Prepare the resource
$WebhookDto = Initialize-maislurp-client-powershellWebhookDto  -BasicAuth null `
 -CreatedAt null `
 -EventName null `
 -Id null `
 -InboxId null `
 -Method null `
 -Name null `
 -PayloadJsonSchema null `
 -UpdatedAt null `
 -Url null `
 -UserId null
  • Convert the resource to JSON
$WebhookDto | ConvertTo-JSON

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