Package com.sendly.resources

Class WebhooksResource

java.lang.Object

com.sendly.resources.WebhooksResource

public class WebhooksResource
extends Object

Webhooks resource for managing webhook endpoints.

Constructor Summary

Constructors

Constructor	Description
WebhooksResource(Sendly client)

Method Summary

Modifier and Type	Method	Description
WebhookCreatedResponse	create(String url, List<String> events)	Create a new webhook endpoint.
WebhookCreatedResponse	create(String url, List<String> events, String description, Map<String,Object> metadata)	Create a new webhook endpoint with options.
void	delete(String webhookId)	Delete a webhook.
Webhook	get(String webhookId)	Get a specific webhook by ID.
List<WebhookDelivery>	getDeliveries(String webhookId)	Get delivery history for a webhook.
List<Webhook>	list()	List all webhooks.
void	retryDelivery(String webhookId, String deliveryId)	Retry a failed delivery.
WebhookCreatedResponse	rotateSecret(String webhookId)	Rotate the webhook signing secret.
WebhookTestResult	test(String webhookId)	Test a webhook endpoint.
Webhook	update(String webhookId, String url, List<String> events, String description, Boolean isActive)	Update a webhook configuration.

Methods inherited from class java.lang.Object

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

Constructor Details

WebhooksResource

public WebhooksResource(Sendly client)

Method Details

create

public WebhookCreatedResponse create(String url,
 List<String> events)
                              throws SendlyException

Create a new webhook endpoint.

Parameters:

url - HTTPS endpoint URL

events - Event types to subscribe to

Returns:

Created webhook with signing secret

Throws:

SendlyException

create

public WebhookCreatedResponse create(String url,
 List<String> events,
 String description,
 Map<String,Object> metadata)
                              throws SendlyException

Create a new webhook endpoint with options.

Parameters:

url - HTTPS endpoint URL

events - Event types to subscribe to

description - Optional description

metadata - Optional metadata

Returns:

Created webhook with signing secret

Throws:

SendlyException

list

public List<Webhook> list()
                   throws SendlyException

List all webhooks.

Throws:

SendlyException

get

public Webhook get(String webhookId)
            throws SendlyException

Get a specific webhook by ID.

Throws:

SendlyException

update

public Webhook update(String webhookId,
 String url,
 List<String> events,
 String description,
 Boolean isActive)
               throws SendlyException

Update a webhook configuration.

Throws:

SendlyException

delete

public void delete(String webhookId)
            throws SendlyException

Delete a webhook.

Throws:

SendlyException

test

public WebhookTestResult test(String webhookId)
                       throws SendlyException

Test a webhook endpoint.

Throws:

SendlyException

rotateSecret

public WebhookCreatedResponse rotateSecret(String webhookId)
                                    throws SendlyException

Rotate the webhook signing secret.

Throws:

SendlyException

getDeliveries

public List<WebhookDelivery> getDeliveries(String webhookId)
                                    throws SendlyException

Get delivery history for a webhook.

Throws:

SendlyException

retryDelivery

public void retryDelivery(String webhookId,
 String deliveryId)
                   throws SendlyException

Retry a failed delivery.

Throws:

SendlyException