Package com.onfido

Class WebhookManager

java.lang.Object

com.onfido.api.ResourceManager

com.onfido.WebhookManager

public class WebhookManager
extends ResourceManager

Manager class for the Webhook resource type. Contains resource-specific methods for interacting with the API.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebhookManager(Config config, okhttp3.OkHttpClient client)

Method Summary

Modifier and Type	Method	Description
Webhook	create(Webhook.Request request)	Registers a webhook.
void	delete(String webhookId)	Deletes a webhook.
Webhook	find(String webhookId)	Retrieves a single webhook.
List<Webhook>	list()	Lists all webhooks you’ve created.
Webhook	update(String webhookId, Webhook.Request request)	Edits a webhook.

Methods inherited from class com.onfido.api.ResourceManager

addFormDataParam, deleteRequest, downloadRequest, get, post, put, readInputStream, uploadRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

WebhookManager

protected WebhookManager(Config config,
                         okhttp3.OkHttpClient client)

Method Detail

create

public Webhook create(Webhook.Request request)
               throws OnfidoException

Registers a webhook.

Parameters:

request - the request body

Returns:

the Webhook

Throws:

OnfidoException - the onfido exception

find

public Webhook find(String webhookId)
             throws OnfidoException

Retrieves a single webhook.

Parameters:

webhookId - the webhook id

Returns:

the Webhook

Throws:

OnfidoException - the onfido exception

update

public Webhook update(String webhookId,
                      Webhook.Request request)
               throws OnfidoException

Edits a webhook.

Parameters:

webhookId - the webhook id

request - the request body

Returns:

the Webhook

Throws:

OnfidoException - the onfido exception

delete

public void delete(String webhookId)
            throws OnfidoException

Deletes a webhook. If successful, returns a 204 No Content response.

Parameters:

webhookId - the webhook id

Throws:

OnfidoException - the onfido exception

list

public List<Webhook> list()
                   throws OnfidoException

Lists all webhooks you’ve created.

Returns:

the list of Webhooks

Throws:

OnfidoException - the onfido exception