CreateWebhookOptions (mailslurp-client-java 15.17.17 API)

java.lang.Object
- com.mailslurp.models.CreateWebhookOptions

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class CreateWebhookOptions
extends Object
```
Options 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. Customize the payload sent to your endpoint by setting the `requestBodyTemplate` property to a string with moustache style variables. Property names from the standard payload model for the given event are available as variables.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CreateWebhookOptions.CustomTypeAdapterFactory`
`static class`	`CreateWebhookOptions.EventNameEnum` Optional webhook event name.

Field Summary

Fields
Modifier and Type	Field and Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_BASIC_AUTH`
`static String`	`SERIALIZED_NAME_EVENT_NAME`
`static String`	`SERIALIZED_NAME_IGNORE_INSECURE_SSL_CERTIFICATES`
`static String`	`SERIALIZED_NAME_INCLUDE_HEADERS`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_REQUEST_BODY_TEMPLATE`
`static String`	`SERIALIZED_NAME_URL`
`static String`	`SERIALIZED_NAME_USE_STATIC_IP_RANGE`

Constructor Summary

Constructors
Constructor and Description

CreateWebhookOptions()

Constructors
Constructor and Description
`CreateWebhookOptions()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateWebhookOptions`	`basicAuth(BasicAuthOptions basicAuth)`
`boolean`	`equals(Object o)`
`CreateWebhookOptions`	`eventName(CreateWebhookOptions.EventNameEnum eventName)`
`static CreateWebhookOptions`	`fromJson(String jsonString)` Create an instance of CreateWebhookOptions given an JSON string
`BasicAuthOptions`	`getBasicAuth()` Get basicAuth
`CreateWebhookOptions.EventNameEnum`	`getEventName()` Optional webhook event name.
`Boolean`	`getIgnoreInsecureSslCertificates()` Ignore insecure SSL certificates when sending request.
`WebhookHeaders`	`getIncludeHeaders()` Get includeHeaders
`String`	`getName()` Optional name for the webhook
`String`	`getRequestBodyTemplate()` Template for the JSON body of the webhook request that will be sent to your server.
`String`	`getUrl()` Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger.
`Boolean`	`getUseStaticIpRange()` Use static IP range when calling webhook endpoint
`int`	`hashCode()`
`CreateWebhookOptions`	`ignoreInsecureSslCertificates(Boolean ignoreInsecureSslCertificates)`
`CreateWebhookOptions`	`includeHeaders(WebhookHeaders includeHeaders)`
`CreateWebhookOptions`	`name(String name)`
`CreateWebhookOptions`	`requestBodyTemplate(String requestBodyTemplate)`
`void`	`setBasicAuth(BasicAuthOptions basicAuth)`
`void`	`setEventName(CreateWebhookOptions.EventNameEnum eventName)`
`void`	`setIgnoreInsecureSslCertificates(Boolean ignoreInsecureSslCertificates)`
`void`	`setIncludeHeaders(WebhookHeaders includeHeaders)`
`void`	`setName(String name)`
`void`	`setRequestBodyTemplate(String requestBodyTemplate)`
`void`	`setUrl(String url)`
`void`	`setUseStaticIpRange(Boolean useStaticIpRange)`
`String`	`toJson()` Convert an instance of CreateWebhookOptions to an JSON string
`String`	`toString()`
`CreateWebhookOptions`	`url(String url)`
`CreateWebhookOptions`	`useStaticIpRange(Boolean useStaticIpRange)`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)` Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_URL
```
public static final String SERIALIZED_NAME_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BASIC_AUTH
```
public static final String SERIALIZED_NAME_BASIC_AUTH
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EVENT_NAME
```
public static final String SERIALIZED_NAME_EVENT_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INCLUDE_HEADERS
```
public static final String SERIALIZED_NAME_INCLUDE_HEADERS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REQUEST_BODY_TEMPLATE
```
public static final String SERIALIZED_NAME_REQUEST_BODY_TEMPLATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USE_STATIC_IP_RANGE
```
public static final String SERIALIZED_NAME_USE_STATIC_IP_RANGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IGNORE_INSECURE_SSL_CERTIFICATES
```
public static final String SERIALIZED_NAME_IGNORE_INSECURE_SSL_CERTIFICATES
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - CreateWebhookOptions
```
public CreateWebhookOptions()
```
- Method Detail
  - url
```
public CreateWebhookOptions url(String url)
```
  - getUrl
```
@Nonnull
public String getUrl()
```
    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.
    
    Returns:
    
    url
  - setUrl
```
public void setUrl(String url)
```
  - basicAuth
```
public CreateWebhookOptions basicAuth(BasicAuthOptions basicAuth)
```
  - getBasicAuth
```
@Nullable
public BasicAuthOptions getBasicAuth()
```
    Get basicAuth
    
    Returns:
    
    basicAuth
  - setBasicAuth
```
public void setBasicAuth(BasicAuthOptions basicAuth)
```
  - name
```
public CreateWebhookOptions name(String name)
```
  - getName
```
@Nullable
public String getName()
```
    Optional name for the webhook
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - eventName
```
public CreateWebhookOptions eventName(CreateWebhookOptions.EventNameEnum eventName)
```
  - getEventName
```
@Nullable
public CreateWebhookOptions.EventNameEnum getEventName()
```
    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.
    
    Returns:
    
    eventName
  - setEventName
```
public void setEventName(CreateWebhookOptions.EventNameEnum eventName)
```
  - includeHeaders
```
public CreateWebhookOptions includeHeaders(WebhookHeaders includeHeaders)
```
  - getIncludeHeaders
```
@Nullable
public WebhookHeaders getIncludeHeaders()
```
    Get includeHeaders
    
    Returns:
    
    includeHeaders
  - setIncludeHeaders
```
public void setIncludeHeaders(WebhookHeaders includeHeaders)
```
  - requestBodyTemplate
```
public CreateWebhookOptions requestBodyTemplate(String requestBodyTemplate)
```
  - getRequestBodyTemplate
```
@Nullable
public String getRequestBodyTemplate()
```
    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.
    
    Returns:
    
    requestBodyTemplate
  - setRequestBodyTemplate
```
public void setRequestBodyTemplate(String requestBodyTemplate)
```
  - useStaticIpRange
```
public CreateWebhookOptions useStaticIpRange(Boolean useStaticIpRange)
```
  - getUseStaticIpRange
```
@Nullable
public Boolean getUseStaticIpRange()
```
    Use static IP range when calling webhook endpoint
    
    Returns:
    
    useStaticIpRange
  - setUseStaticIpRange
```
public void setUseStaticIpRange(Boolean useStaticIpRange)
```
  - ignoreInsecureSslCertificates
```
public CreateWebhookOptions ignoreInsecureSslCertificates(Boolean ignoreInsecureSslCertificates)
```
  - getIgnoreInsecureSslCertificates
```
@Nullable
public Boolean getIgnoreInsecureSslCertificates()
```
    Ignore insecure SSL certificates when sending request. Useful for self-signed certs.
    
    Returns:
    
    ignoreInsecureSslCertificates
  - setIgnoreInsecureSslCertificates
```
public void setIgnoreInsecureSslCertificates(Boolean ignoreInsecureSslCertificates)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validateJsonObject
```
public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException
```
    Validates the JSON Object and throws an exception if issues found
    
    Parameters:
    
    jsonObj - JSON Object
    
    Throws:
    
    IOException - if the JSON Object is invalid with respect to CreateWebhookOptions
  - fromJson
```
public static CreateWebhookOptions fromJson(String jsonString)
                                     throws IOException
```
    Create an instance of CreateWebhookOptions given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of CreateWebhookOptions
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to CreateWebhookOptions
  - toJson
```
public String toJson()
```
    Convert an instance of CreateWebhookOptions to an JSON string
    
    Returns:
    
    JSON string

Class CreateWebhookOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_URL

SERIALIZED_NAME_BASIC_AUTH

SERIALIZED_NAME_NAME

SERIALIZED_NAME_EVENT_NAME

SERIALIZED_NAME_INCLUDE_HEADERS

SERIALIZED_NAME_REQUEST_BODY_TEMPLATE

SERIALIZED_NAME_USE_STATIC_IP_RANGE

SERIALIZED_NAME_IGNORE_INSECURE_SSL_CERTIFICATES

openapiFields

openapiRequiredFields

Constructor Detail

CreateWebhookOptions

Method Detail

url

getUrl

setUrl

basicAuth

getBasicAuth

setBasicAuth

name

getName

setName

eventName

getEventName

setEventName

includeHeaders

getIncludeHeaders

setIncludeHeaders

requestBodyTemplate

getRequestBodyTemplate

setRequestBodyTemplate

useStaticIpRange

getUseStaticIpRange

setUseStaticIpRange

ignoreInsecureSslCertificates

getIgnoreInsecureSslCertificates

setIgnoreInsecureSslCertificates

equals

hashCode

toString

validateJsonObject

fromJson

toJson