Struct mailslurp::models::create_webhook_options::CreateWebhookOptions

pub struct CreateWebhookOptions {
    pub basic_auth: Option<Box<BasicAuthOptions>>,
    pub event_name: Option<EventName>,
    pub name: Option<String>,
    pub url: Option<String>,
}

CreateWebhookOptions : Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the inbox receives an email. Webhooks are great for processing many inbound emails.

Fields

basic_auth: Option<Box<BasicAuthOptions>>

event_name: Option<EventName>

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. The other events are NEW_EMAIL, NEW_CONTACT, and NEW_ATTACHMENT and EMAIL_OPENED. EMAIL_OPENED requires the use of tracking pixels when sending. See the email tracking guide for more information.

name: Option<String>

Optional name for the webhook

url: Option<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. The default EMAIL_RECEIVED payload is described by https://api.mailslurp.com/schemas/webhook-payload. The other events, NEW_EMAIL, NEW_CONTACT, and NEW_ATTACHMENT are described by https://api.mailslurp.com/schemas/webhook-new-email-payload, https://api.mailslurp.com/schemas/webhook-new-contact-payload,https://api.mailslurp.com/schemas/webhook-new-attachment-payload respectively.

Implementations

impl CreateWebhookOptions

pub fn new() -> CreateWebhookOptions

Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the inbox receives an email. Webhooks are great for processing many inbound emails.

Trait Implementations

impl Clone for CreateWebhookOptions

fn clone(&self) -> CreateWebhookOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateWebhookOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateWebhookOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<CreateWebhookOptions> for CreateWebhookOptions

fn eq(&self, other: &CreateWebhookOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateWebhookOptions) -> bool

This method tests for !=.

impl Serialize for CreateWebhookOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateWebhookOptions