Interface WebhookServiceAsync
-
- All Implemented Interfaces:
public interface WebhookServiceAsync
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceWebhookServiceAsync.WithRawResponseA view of WebhookServiceAsync that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract WebhookServiceAsync.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract WebhookServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
create
CompletableFuture<Webhook> create(WebhookCreateParams params)
Creates a new webhook and returns the created object, including the generated signing
secret.ImageKit sends a
POSTrequest to the webhookendpointwhenever one of the subscribedeventsoccurs. Use thesecretto verify the signature of each request. Learn more about webhooks.You can create up to 3 webhooks per account.
-
create
abstract CompletableFuture<Webhook> create(WebhookCreateParams params, RequestOptions requestOptions)
-
update
CompletableFuture<Webhook> update(String id)
Updates the webhook identified by
idand returns the updated object. Only the fields included in the request body are changed.When
eventsis provided, it replaces the existing list of subscribed events. The signingsecretcan't be changed.
-
update
CompletableFuture<Webhook> update(String id, WebhookUpdateParams params, RequestOptions requestOptions)
-
update
CompletableFuture<Webhook> update(String id, WebhookUpdateParams params)
-
update
abstract CompletableFuture<Webhook> update(WebhookUpdateParams params, RequestOptions requestOptions)
-
update
CompletableFuture<Webhook> update(WebhookUpdateParams params)
-
update
CompletableFuture<Webhook> update(String id, RequestOptions requestOptions)
-
list
CompletableFuture<List<Webhook>> list()
Returns an array of all webhooks configured for your account.
-
list
abstract CompletableFuture<List<Webhook>> list(WebhookListParams params, RequestOptions requestOptions)
-
list
CompletableFuture<List<Webhook>> list(WebhookListParams params)
-
list
CompletableFuture<List<Webhook>> list(RequestOptions requestOptions)
-
delete
CompletableFuture<Void> delete(String id)
Permanently deletes the webhook identified by
id. ImageKit stops sending events to its endpoint.
-
delete
CompletableFuture<Void> delete(String id, WebhookDeleteParams params, RequestOptions requestOptions)
-
delete
CompletableFuture<Void> delete(String id, WebhookDeleteParams params)
-
delete
abstract CompletableFuture<Void> delete(WebhookDeleteParams params, RequestOptions requestOptions)
-
delete
CompletableFuture<Void> delete(WebhookDeleteParams params)
-
delete
CompletableFuture<Void> delete(String id, RequestOptions requestOptions)
-
get
CompletableFuture<Webhook> get(String id)
Retrieves the webhook identified by
id.
-
get
CompletableFuture<Webhook> get(String id, WebhookGetParams params, RequestOptions requestOptions)
-
get
CompletableFuture<Webhook> get(String id, WebhookGetParams params)
-
get
abstract CompletableFuture<Webhook> get(WebhookGetParams params, RequestOptions requestOptions)
-
get
CompletableFuture<Webhook> get(WebhookGetParams params)
-
get
CompletableFuture<Webhook> get(String id, RequestOptions requestOptions)
-
-
-
-