-
public final class CreateWebhookOptionsOptions for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the webhook's event is triggered. Webhooks are great for processing many inbound emails and responding to other events at scale.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumCreateWebhookOptions.EventNameOptional webhook event name. Default is
EMAIL_RECEIVEDand is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name. Values: eMAILRECEIVED,nEWEMAIL,nEWCONTACT,nEWATTACHMENT,eMAILOPENED,eMAILREAD,bOUNCE,bOUNCERECIPIENT,nEWSMS
-
Field Summary
Fields Modifier and Type Field Description private final Stringurlprivate final BasicAuthOptionsbasicAuthprivate final Stringnameprivate final CreateWebhookOptions.EventNameeventNameprivate final WebhookHeadersincludeHeaders
-
Constructor Summary
Constructors Constructor Description CreateWebhookOptions(String url, BasicAuthOptions basicAuth, String name, CreateWebhookOptions.EventName eventName, WebhookHeaders includeHeaders)
-
Method Summary
Modifier and Type Method Description final StringgetUrl()final BasicAuthOptionsgetBasicAuth()final StringgetName()final CreateWebhookOptions.EventNamegetEventName()final WebhookHeadersgetIncludeHeaders()-
-
Constructor Detail
-
CreateWebhookOptions
CreateWebhookOptions(String url, BasicAuthOptions basicAuth, String name, CreateWebhookOptions.EventName eventName, WebhookHeaders includeHeaders)
- Parameters:
url- Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger.name- Optional name for the webhookeventName- Optional webhook event name.
-
-
Method Detail
-
getBasicAuth
final BasicAuthOptions getBasicAuth()
-
getEventName
final CreateWebhookOptions.EventName getEventName()
-
getIncludeHeaders
final WebhookHeaders getIncludeHeaders()
-
-
-
-