org.wisepersist.pinpayments.api

Interface WebhooksApi

All Known Implementing Classes:

WebhooksApiImpl

public interface WebhooksApi

The webhooks API allows you to view and replay webhook requests that have been sent to your webhook endpoints. When an event is created, a unique webhook request is created and sent to each webhook endpoint.

Replaying a webhook re-sends a webhook request to its original URL. It will not re-send other webhook requests for the same event. Replaying a webhook will reset the error information recorded for the original request and record any new errors that occur during the replay.

See Also:

Webhooks API

Method Summary

Modifier and Type	Method and Description
WebhookResponse	fetch(java.lang.String webhookToken) Returns the details of a webhook.
WebhookListResponse	list(int page) Returns a paginated list of all webhooks.
WebhookResponse	replay(java.lang.String webhookToken) Replays a webhook.

Method Detail

list

WebhookListResponse list(int page)
                  throws java.io.IOException

Returns a paginated list of all webhooks.

Parameters:

page - The page number specified.

Returns:

A paginated list of all webhooks.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

fetch

WebhookResponse fetch(java.lang.String webhookToken)
               throws java.io.IOException

Returns the details of a webhook.

Parameters:

webhookToken - The webhook token specified.

Returns:

The details of a webhook.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

replay

WebhookResponse replay(java.lang.String webhookToken)
                throws java.io.IOException

Replays a webhook.

Parameters:

webhookToken - The webhook token specified.

Returns:

The details of the webhook replayed.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.