Interface WebhookService
-
- All Implemented Interfaces:
public interface WebhookService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceWebhookService.WithRawResponseA view of WebhookService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract WebhookService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract WebhookServicewithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. Webhookcreate(WebhookCreateParams params)Creates a new webhook and returns the created object, including the generated signing secret.abstract Webhookcreate(WebhookCreateParams params, RequestOptions requestOptions)Webhookupdate(String id)Updates the webhook identified by idand returns the updated object.Webhookupdate(String id, WebhookUpdateParams params, RequestOptions requestOptions)Webhookupdate(String id, WebhookUpdateParams params)abstract Webhookupdate(WebhookUpdateParams params, RequestOptions requestOptions)Webhookupdate(WebhookUpdateParams params)Webhookupdate(String id, RequestOptions requestOptions)List<Webhook>list()Returns an array of all webhooks configured for your account. abstract List<Webhook>list(WebhookListParams params, RequestOptions requestOptions)List<Webhook>list(WebhookListParams params)List<Webhook>list(RequestOptions requestOptions)Unitdelete(String id)Permanently deletes the webhook identified by id.Unitdelete(String id, WebhookDeleteParams params, RequestOptions requestOptions)Unitdelete(String id, WebhookDeleteParams params)abstract Unitdelete(WebhookDeleteParams params, RequestOptions requestOptions)Unitdelete(WebhookDeleteParams params)Unitdelete(String id, RequestOptions requestOptions)Webhookget(String id)Retrieves the webhook identified by id.Webhookget(String id, WebhookGetParams params, RequestOptions requestOptions)Webhookget(String id, WebhookGetParams params)abstract Webhookget(WebhookGetParams params, RequestOptions requestOptions)Webhookget(WebhookGetParams params)Webhookget(String id, RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract WebhookService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract WebhookService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
create
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 Webhook create(WebhookCreateParams params, RequestOptions requestOptions)
-
update
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
Webhook update(String id, WebhookUpdateParams params, RequestOptions requestOptions)
-
update
Webhook update(String id, WebhookUpdateParams params)
-
update
abstract Webhook update(WebhookUpdateParams params, RequestOptions requestOptions)
-
update
Webhook update(WebhookUpdateParams params)
-
update
Webhook update(String id, RequestOptions requestOptions)
-
list
abstract List<Webhook> list(WebhookListParams params, RequestOptions requestOptions)
-
list
List<Webhook> list(WebhookListParams params)
-
list
List<Webhook> list(RequestOptions requestOptions)
-
delete
Unit delete(String id)
Permanently deletes the webhook identified by
id. ImageKit stops sending events to its endpoint.
-
delete
Unit delete(String id, WebhookDeleteParams params, RequestOptions requestOptions)
-
delete
Unit delete(String id, WebhookDeleteParams params)
-
delete
abstract Unit delete(WebhookDeleteParams params, RequestOptions requestOptions)
-
delete
Unit delete(WebhookDeleteParams params)
-
delete
Unit delete(String id, RequestOptions requestOptions)
-
get
Webhook get(String id, WebhookGetParams params, RequestOptions requestOptions)
-
get
Webhook get(String id, WebhookGetParams params)
-
get
abstract Webhook get(WebhookGetParams params, RequestOptions requestOptions)
-
get
Webhook get(WebhookGetParams params)
-
get
Webhook get(String id, RequestOptions requestOptions)
-
-
-
-