All Implemented Interfaces:


public interface WebhookServiceAsync

Configure webhook endpoints for real-time event delivery

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`WebhookServiceAsync.WithRawResponse`	A view of WebhookServiceAsync that provides access to raw HTTP responses for each method.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract WebhookServiceAsync.WithRawResponse`	`withRawResponse()`	Returns a view of this service that provides access to raw HTTP responses for each method.
`abstract WebhookServiceAsync`	`withOptions(Consumer<ClientOptions.Builder> modifier)`	Returns a view of this service with the given option modifications applied.
`CompletableFuture<ApiResponseWebhook>`	`create()`	Creates a new webhook endpoint for the authenticated customer.
`abstract CompletableFuture<ApiResponseWebhook>`	`create(WebhookCreateParams params, RequestOptions requestOptions)`
`CompletableFuture<ApiResponseWebhook>`	`create(WebhookCreateParams params)`
`CompletableFuture<ApiResponseWebhook>`	`create(RequestOptions requestOptions)`
`CompletableFuture<ApiResponseWebhook>`	`retrieve(String id)`	Retrieves a single webhook by ID for the authenticated customer.
`CompletableFuture<ApiResponseWebhook>`	`retrieve(String id, WebhookRetrieveParams params, RequestOptions requestOptions)`
`CompletableFuture<ApiResponseWebhook>`	`retrieve(String id, WebhookRetrieveParams params)`
`abstract CompletableFuture<ApiResponseWebhook>`	`retrieve(WebhookRetrieveParams params, RequestOptions requestOptions)`
`CompletableFuture<ApiResponseWebhook>`	`retrieve(WebhookRetrieveParams params)`
`CompletableFuture<ApiResponseWebhook>`	`retrieve(String id, RequestOptions requestOptions)`
`CompletableFuture<ApiResponseWebhook>`	`update(String id)`	Updates an existing webhook for the authenticated customer.
`CompletableFuture<ApiResponseWebhook>`	`update(String id, WebhookUpdateParams params, RequestOptions requestOptions)`
`CompletableFuture<ApiResponseWebhook>`	`update(String id, WebhookUpdateParams params)`
`abstract CompletableFuture<ApiResponseWebhook>`	`update(WebhookUpdateParams params, RequestOptions requestOptions)`
`CompletableFuture<ApiResponseWebhook>`	`update(WebhookUpdateParams params)`
`CompletableFuture<ApiResponseWebhook>`	`update(String id, RequestOptions requestOptions)`
`CompletableFuture<WebhookListResponse>`	`list(WebhookListParams params)`	Retrieves a paginated list of webhooks for the authenticated customer.
`abstract CompletableFuture<WebhookListResponse>`	`list(WebhookListParams params, RequestOptions requestOptions)`
`CompletableFuture<Void>`	`delete(String id)`	Deletes a webhook for the authenticated customer.
`CompletableFuture<Void>`	`delete(String id, WebhookDeleteParams params, RequestOptions requestOptions)`
`CompletableFuture<Void>`	`delete(String id, WebhookDeleteParams params)`
`abstract CompletableFuture<Void>`	`delete(WebhookDeleteParams params, RequestOptions requestOptions)`
`CompletableFuture<Void>`	`delete(WebhookDeleteParams params)`
`CompletableFuture<Void>`	`delete(String id, RequestOptions requestOptions)`
`CompletableFuture<WebhookListEventTypesResponse>`	`listEventTypes()`	Retrieves all available webhook event types that can be subscribed to.
`abstract CompletableFuture<WebhookListEventTypesResponse>`	`listEventTypes(WebhookListEventTypesParams params, RequestOptions requestOptions)`
`CompletableFuture<WebhookListEventTypesResponse>`	`listEventTypes(WebhookListEventTypesParams params)`
`CompletableFuture<WebhookListEventTypesResponse>`	`listEventTypes(RequestOptions requestOptions)`
`CompletableFuture<WebhookListEventsResponse>`	`listEvents(String id, WebhookListEventsParams params)`	Retrieves a paginated list of delivery events for the specified webhook.
`CompletableFuture<WebhookListEventsResponse>`	`listEvents(String id, WebhookListEventsParams params, RequestOptions requestOptions)`
`CompletableFuture<WebhookListEventsResponse>`	`listEvents(WebhookListEventsParams params)`
`abstract CompletableFuture<WebhookListEventsResponse>`	`listEvents(WebhookListEventsParams params, RequestOptions requestOptions)`
`CompletableFuture<WebhookRotateSecretResponse>`	`rotateSecret(String id)`	Generates a new signing secret for the specified webhook.
`CompletableFuture<WebhookRotateSecretResponse>`	`rotateSecret(String id, WebhookRotateSecretParams params, RequestOptions requestOptions)`
`CompletableFuture<WebhookRotateSecretResponse>`	`rotateSecret(String id, WebhookRotateSecretParams params)`
`abstract CompletableFuture<WebhookRotateSecretResponse>`	`rotateSecret(WebhookRotateSecretParams params, RequestOptions requestOptions)`
`CompletableFuture<WebhookRotateSecretResponse>`	`rotateSecret(WebhookRotateSecretParams params)`
`CompletableFuture<WebhookRotateSecretResponse>`	`rotateSecret(String id, RequestOptions requestOptions)`
`CompletableFuture<WebhookTestResponse>`	`test(String id)`	Sends a test event to the specified webhook endpoint to verify connectivity.
`CompletableFuture<WebhookTestResponse>`	`test(String id, WebhookTestParams params, RequestOptions requestOptions)`
`CompletableFuture<WebhookTestResponse>`	`test(String id, WebhookTestParams params)`
`abstract CompletableFuture<WebhookTestResponse>`	`test(WebhookTestParams params, RequestOptions requestOptions)`
`CompletableFuture<WebhookTestResponse>`	`test(WebhookTestParams params)`
`CompletableFuture<WebhookTestResponse>`	`test(String id, RequestOptions requestOptions)`
`CompletableFuture<ApiResponseWebhook>`	`toggleStatus(String id)`	Activates or deactivates a webhook for the authenticated customer.
`CompletableFuture<ApiResponseWebhook>`	`toggleStatus(String id, WebhookToggleStatusParams params, RequestOptions requestOptions)`
`CompletableFuture<ApiResponseWebhook>`	`toggleStatus(String id, WebhookToggleStatusParams params)`
`abstract CompletableFuture<ApiResponseWebhook>`	`toggleStatus(WebhookToggleStatusParams params, RequestOptions requestOptions)`
`CompletableFuture<ApiResponseWebhook>`	`toggleStatus(WebhookToggleStatusParams params)`
`CompletableFuture<ApiResponseWebhook>`	`toggleStatus(String id, RequestOptions requestOptions)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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<ApiResponseWebhook> create()
```
Creates a new webhook endpoint for the authenticated customer.

create

 abstract CompletableFuture<ApiResponseWebhook> create(WebhookCreateParams params, RequestOptions requestOptions)

create

 CompletableFuture<ApiResponseWebhook> create(WebhookCreateParams params)

create

 CompletableFuture<ApiResponseWebhook> create(RequestOptions requestOptions)

retrieve
```
 CompletableFuture<ApiResponseWebhook> retrieve(String id)
```
Retrieves a single webhook by ID for the authenticated customer.

retrieve

 CompletableFuture<ApiResponseWebhook> retrieve(String id, WebhookRetrieveParams params, RequestOptions requestOptions)

retrieve

 CompletableFuture<ApiResponseWebhook> retrieve(String id, WebhookRetrieveParams params)

retrieve

 abstract CompletableFuture<ApiResponseWebhook> retrieve(WebhookRetrieveParams params, RequestOptions requestOptions)

retrieve

 CompletableFuture<ApiResponseWebhook> retrieve(WebhookRetrieveParams params)

retrieve

 CompletableFuture<ApiResponseWebhook> retrieve(String id, RequestOptions requestOptions)

update
```
 CompletableFuture<ApiResponseWebhook> update(String id)
```
Updates an existing webhook for the authenticated customer.

update

 CompletableFuture<ApiResponseWebhook> update(String id, WebhookUpdateParams params, RequestOptions requestOptions)

update

 CompletableFuture<ApiResponseWebhook> update(String id, WebhookUpdateParams params)

update

 abstract CompletableFuture<ApiResponseWebhook> update(WebhookUpdateParams params, RequestOptions requestOptions)

update

 CompletableFuture<ApiResponseWebhook> update(WebhookUpdateParams params)

update

 CompletableFuture<ApiResponseWebhook> update(String id, RequestOptions requestOptions)

list

 CompletableFuture<WebhookListResponse> list(WebhookListParams params)

Retrieves a paginated list of webhooks for the authenticated customer.

list

 abstract CompletableFuture<WebhookListResponse> list(WebhookListParams params, RequestOptions requestOptions)

delete
```
 CompletableFuture<Void> delete(String id)
```
Deletes a webhook for the authenticated customer.

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)

listEventTypes
```
 CompletableFuture<WebhookListEventTypesResponse> listEventTypes()
```
Retrieves all available webhook event types that can be subscribed to.

listEventTypes

 abstract CompletableFuture<WebhookListEventTypesResponse> listEventTypes(WebhookListEventTypesParams params, RequestOptions requestOptions)

listEventTypes

 CompletableFuture<WebhookListEventTypesResponse> listEventTypes(WebhookListEventTypesParams params)

listEventTypes

 CompletableFuture<WebhookListEventTypesResponse> listEventTypes(RequestOptions requestOptions)

listEvents

 CompletableFuture<WebhookListEventsResponse> listEvents(String id, WebhookListEventsParams params)

Retrieves a paginated list of delivery events for the specified webhook.

listEvents

 CompletableFuture<WebhookListEventsResponse> listEvents(String id, WebhookListEventsParams params, RequestOptions requestOptions)

listEvents

 CompletableFuture<WebhookListEventsResponse> listEvents(WebhookListEventsParams params)

listEvents

 abstract CompletableFuture<WebhookListEventsResponse> listEvents(WebhookListEventsParams params, RequestOptions requestOptions)

rotateSecret
```
 CompletableFuture<WebhookRotateSecretResponse> rotateSecret(String id)
```
Generates a new signing secret for the specified webhook. The old secret is immediately invalidated.

rotateSecret

 CompletableFuture<WebhookRotateSecretResponse> rotateSecret(String id, WebhookRotateSecretParams params, RequestOptions requestOptions)

rotateSecret

 CompletableFuture<WebhookRotateSecretResponse> rotateSecret(String id, WebhookRotateSecretParams params)

rotateSecret

 abstract CompletableFuture<WebhookRotateSecretResponse> rotateSecret(WebhookRotateSecretParams params, RequestOptions requestOptions)

rotateSecret

 CompletableFuture<WebhookRotateSecretResponse> rotateSecret(WebhookRotateSecretParams params)

rotateSecret

 CompletableFuture<WebhookRotateSecretResponse> rotateSecret(String id, RequestOptions requestOptions)

test
```
 CompletableFuture<WebhookTestResponse> test(String id)
```
Sends a test event to the specified webhook endpoint to verify connectivity.

test

 CompletableFuture<WebhookTestResponse> test(String id, WebhookTestParams params, RequestOptions requestOptions)

test

 CompletableFuture<WebhookTestResponse> test(String id, WebhookTestParams params)

test

 abstract CompletableFuture<WebhookTestResponse> test(WebhookTestParams params, RequestOptions requestOptions)

test

 CompletableFuture<WebhookTestResponse> test(WebhookTestParams params)

test

 CompletableFuture<WebhookTestResponse> test(String id, RequestOptions requestOptions)

toggleStatus
```
 CompletableFuture<ApiResponseWebhook> toggleStatus(String id)
```
Activates or deactivates a webhook for the authenticated customer.

toggleStatus

 CompletableFuture<ApiResponseWebhook> toggleStatus(String id, WebhookToggleStatusParams params, RequestOptions requestOptions)

toggleStatus

 CompletableFuture<ApiResponseWebhook> toggleStatus(String id, WebhookToggleStatusParams params)

toggleStatus

 abstract CompletableFuture<ApiResponseWebhook> toggleStatus(WebhookToggleStatusParams params, RequestOptions requestOptions)

toggleStatus

 CompletableFuture<ApiResponseWebhook> toggleStatus(WebhookToggleStatusParams params)

toggleStatus

 CompletableFuture<ApiResponseWebhook> toggleStatus(String id, RequestOptions requestOptions)

Interface WebhookServiceAsync

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

withRawResponse

withOptions

create

create

create

create

retrieve

retrieve

retrieve

retrieve

retrieve

retrieve

update

update

update

update

update

update

list

list

delete

delete

delete

delete

delete

delete

listEventTypes

listEventTypes

listEventTypes

listEventTypes

listEvents

listEvents

listEvents

listEvents

rotateSecret

rotateSecret

rotateSecret

rotateSecret

rotateSecret

rotateSecret

test

test

test

test

test

test

toggleStatus

toggleStatus

toggleStatus

toggleStatus

toggleStatus

toggleStatus