Struct mailslurp::models::create_webhook_options::CreateWebhookOptions [−][src]
pub struct CreateWebhookOptions { pub basic_auth: Option<Box<BasicAuthOptions>>, pub event_name: Option<EventName>, pub name: Option<String>, pub url: Option<String>, }
Expand description
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
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
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for CreateWebhookOptions
impl Send for CreateWebhookOptions
impl Sync for CreateWebhookOptions
impl Unpin for CreateWebhookOptions
impl UnwindSafe for CreateWebhookOptions
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more