CreateWebhookOptions class

Constructors

CreateWebhookOptions({required String url, BasicAuthOptions? basicAuth, String? name, CreateWebhookOptionsEventNameEnum? eventName, WebhookHeaders? includeHeaders, String? requestBodyTemplate, bool? useStaticIpRange = false, bool? ignoreInsecureSslCertificates})

Returns a new CreateWebhookOptions instance.

Properties

basicAuth ↔ BasicAuthOptions?

getter/setter pair

eventName ↔ CreateWebhookOptionsEventNameEnum?

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.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

ignoreInsecureSslCertificates ↔ bool?

Ignore insecure SSL certificates when sending request. Useful for self-signed certs.

getter/setter pair

includeHeaders ↔ WebhookHeaders?

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

name ↔ String?

Optional name for the webhook

getter/setter pair

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.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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.

getter/setter pair

useStaticIpRange ↔ bool?

Use static IP range when calling webhook endpoint

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → CreateWebhookOptions?

Returns a new CreateWebhookOptions instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<CreateWebhookOptions>

mapFromJson(dynamic json) → Map<String, CreateWebhookOptions>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<CreateWebhookOptions>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.