WebhookDto class
Constructors
WebhookDto ({required String id , required String userId , required bool basicAuth , String ?name , String ?phoneId , String ?inboxId , String ?requestBodyTemplate , required String url , required WebhookDtoMethodEnum method , required String payloadJsonSchema , required DateTime ?createdAt , required DateTime updatedAt , WebhookDtoEventNameEnum ?eventName , bool ?ignoreInsecureSslCertificates , bool ?useStaticIpRange
Returns a new WebhookDto instance.
Properties
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.
getter/setter pair
createdAt ↔ DateTime ?
When the webhook was created
getter/setter pair
eventName ↔ WebhookDtoEventNameEnum ?
Webhook trigger event name
getter/setter pair
hashCode → int
The hash code for this object.
no setter override
id ↔ String
ID of the Webhook
getter/setter pair
ignoreInsecureSslCertificates ↔ bool ?
Should notifier ignore insecure SSL certificates
getter/setter pair
inboxId ↔ String ?
The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set
getter/setter pair
method ↔ WebhookDtoMethodEnum
HTTP method that your server endpoint must listen for
getter/setter pair
name ↔ String ?
Name of the webhook
getter/setter pair
payloadJsonSchema ↔ String
Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method
getter/setter pair
phoneId ↔ String ?
The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set
getter/setter pair
requestBodyTemplate ↔ 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.
getter/setter pair
Please note: This property should have been non-nullable! Since the specification file
does not include a default value (using the "default:" property), however, the generated
source code must fall back to having a nullable type.
Consider adding a "default:" property in the specification file to hide this note.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
updatedAt ↔ DateTime
getter/setter pair
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.
getter/setter pair
userId ↔ String
User ID of the Webhook
getter/setter pair
useStaticIpRange ↔ bool ?
Should notifier use static IP range when sending webhook payload
getter/setter pair
