Package com.onfido.models

Class Webhook.Request

java.lang.Object

com.onfido.models.Webhook.Request

Enclosing class:

Webhook

public static final class Webhook.Request
extends Object

Method Summary

Modifier and Type	Method	Description
Webhook.Request	enabled(Boolean enabled)	Determines if the webhook should be active.
Webhook.Request	environment(String... environment)	The environment to be used
Webhook.Request	environment(List<String> environment)	The environment to be used
Webhook.Request	events(String... events)	The events that should be published to the webhook.
Webhook.Request	events(List<String> events)	The events that should be published to the webhook.
Boolean	getEnabled()	Determines if the webhook should be active.
String[]	getEnvironment()	The environment to be used
String[]	getEvents()	The events that should be published to the webhook.
String	getUrl()	The url to listen to notifications (must be HTTPS)
String	toJson()
String	toString()
Webhook.Request	url(String url)	The url to listen to notifications (must be HTTPS)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

toJson

public String toJson()

toString

public String toString()

Overrides:

toString in class Object

url

public Webhook.Request url(String url)

The url to listen to notifications (must be HTTPS)

Parameters:

url - The url to listen to notifications (must be HTTPS)

Returns:

The Webhook request object.

enabled

public Webhook.Request enabled(Boolean enabled)

Determines if the webhook should be active. If omitted, will be set to true by default

Parameters:

enabled - Determines if the webhook should be active. If omitted, will be set to true by default

Returns:

The Webhook request object.

events

public Webhook.Request events(List<String> events)

The events that should be published to the webhook. If omitted, all events will be subscribed by default. You can read about the supported events

Parameters:

events - The events that should be published to the webhook. If omitted, all events will be subscribed by default. You can read about the supported events

Returns:

The Webhook request object.

events

public Webhook.Request events(String... events)

The events that should be published to the webhook. If omitted, all events will be subscribed by default. You can read about the supported events

Parameters:

events - The events that should be published to the webhook. If omitted, all events will be subscribed by default. You can read about the supported events

Returns:

The Webhook request object

environment

public Webhook.Request environment(List<String> environment)

The environment to be used

Parameters:

environment - The environment to be used

Returns:

The Webhook request object.

environment

public Webhook.Request environment(String... environment)

The environment to be used

Parameters:

environment - The environment to be used

Returns:

The Webhook request object

getUrl

public String getUrl()

The url to listen to notifications (must be HTTPS)

Returns:

The url to listen to notifications (must be HTTPS)

getEnabled

public Boolean getEnabled()

Determines if the webhook should be active. If omitted, will be set to true by default

Returns:

Determines if the webhook should be active. If omitted, will be set to true by default

getEvents

public String[] getEvents()

The events that should be published to the webhook. If omitted, all events will be subscribed by default. You can read about the supported events

Returns:

The events that should be published to the webhook. If omitted, all events will be subscribed by default. You can read about the supported events

getEnvironment

public String[] getEnvironment()

The environment to be used

Returns:

The environment to be used