Package africa.sendbyte.webhooks

Class Webhooks

java.lang.Object

africa.sendbyte.webhooks.Webhooks

public final class Webhooks
extends Object

The Webhooks resource: register and manage webhook endpoints, inspect delivery history, and replay deliveries.

Obtain an instance via client.webhooks(). Every method has a blocking form and an ...Async form returning a CompletableFuture. To verify the signature on incoming deliveries, use WebhookSignature.

Constructor Summary

Constructors

Constructor	Description
Webhooks(RequestExecutor executor)

Method Summary

Modifier and Type	Method	Description
WebhookEndpoint	create(String url)	Register an endpoint subscribed to all event types.
WebhookEndpoint	create(String url, List<String> events)	Register an endpoint subscribed to specific event types (e.g.
CompletableFuture<WebhookEndpoint>	createAsync(String url, List<String> events)	Asynchronous create(String, List).
WebhookDeliveryList	deliveries(String endpointId)	Fetch the recent delivery attempts (up to the last 50) for an endpoint.
CompletableFuture<WebhookDeliveryList>	deliveriesAsync(String endpointId)	Asynchronous deliveries(String).
void	disable(String id)	Disable an endpoint so it stops receiving deliveries.
CompletableFuture<Void>	disableAsync(String id)	Asynchronous disable(String).
WebhookEndpointList	list()	List all webhook endpoints on the account.
CompletableFuture<WebhookEndpointList>	listAsync()	Asynchronous list().
WebhookDelivery	replay(String deliveryId)	Re-enqueue a past delivery as a fresh attempt.
CompletableFuture<WebhookDelivery>	replayAsync(String deliveryId)	Asynchronous replay(String).

Methods inherited from class java.lang.Object

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

Constructor Details

Webhooks

public Webhooks(RequestExecutor executor)

Method Details

create

public WebhookEndpoint create(String url)

Register an endpoint subscribed to all event types.

create

public WebhookEndpoint create(String url,
 List<String> events)

Register an endpoint subscribed to specific event types (e.g. ["email.delivered", "email.bounced"]). Pass null or an empty list to receive all events. The response includes the one-time signing secret.

createAsync

public CompletableFuture<WebhookEndpoint> createAsync(String url,
 List<String> events)

Asynchronous create(String, List).

list

public WebhookEndpointList list()

List all webhook endpoints on the account. Signing secrets are not included.

listAsync

public CompletableFuture<WebhookEndpointList> listAsync()

Asynchronous list().

disable

public void disable(String id)

Disable an endpoint so it stops receiving deliveries. Delivery history is retained.

disableAsync

public CompletableFuture<Void> disableAsync(String id)

Asynchronous disable(String).

deliveries

public WebhookDeliveryList deliveries(String endpointId)

Fetch the recent delivery attempts (up to the last 50) for an endpoint.

deliveriesAsync

public CompletableFuture<WebhookDeliveryList> deliveriesAsync(String endpointId)

Asynchronous deliveries(String).

replay

public WebhookDelivery replay(String deliveryId)

Re-enqueue a past delivery as a fresh attempt. Returns the new delivery record.

replayAsync

public CompletableFuture<WebhookDelivery> replayAsync(String deliveryId)

Asynchronous replay(String).