Interface EndpointServiceAsync
-
- All Implemented Interfaces:
public interface EndpointServiceAsyncWebhook endpoint management
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceEndpointServiceAsync.WithRawResponseA view of EndpointServiceAsync that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract EndpointServiceAsync.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract EndpointServiceAsync 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<Void> create(EndpointCreateParams params)
Creates a webhook endpoint that receives platform events matching the supplied event-type filters. Returns the generated signing secret ONCE — the response is the only time it is shown in plaintext.
-
create
abstract CompletableFuture<Void> create(EndpointCreateParams params, RequestOptions requestOptions)
-
retrieve
CompletableFuture<Void> retrieve(String id)
Get webhook endpoint
-
retrieve
CompletableFuture<Void> retrieve(String id, EndpointRetrieveParams params, RequestOptions requestOptions)
-
retrieve
CompletableFuture<Void> retrieve(String id, EndpointRetrieveParams params)
-
retrieve
abstract CompletableFuture<Void> retrieve(EndpointRetrieveParams params, RequestOptions requestOptions)
-
retrieve
CompletableFuture<Void> retrieve(EndpointRetrieveParams params)
-
retrieve
CompletableFuture<Void> retrieve(String id, RequestOptions requestOptions)
-
update
CompletableFuture<Void> update(String id)
Partially updates a webhook endpoint. Any omitted field is left unchanged. Signing secrets are rotated via the separate /rotate_secret endpoint.
-
update
CompletableFuture<Void> update(String id, EndpointUpdateParams params, RequestOptions requestOptions)
-
update
CompletableFuture<Void> update(String id, EndpointUpdateParams params)
-
update
abstract CompletableFuture<Void> update(EndpointUpdateParams params, RequestOptions requestOptions)
-
update
CompletableFuture<Void> update(EndpointUpdateParams params)
-
update
CompletableFuture<Void> update(String id, RequestOptions requestOptions)
-
list
CompletableFuture<Void> list()
Returns the organization's webhook endpoints, newest first. Signing secrets are never included.
-
list
abstract CompletableFuture<Void> list(EndpointListParams params, RequestOptions requestOptions)
-
list
CompletableFuture<Void> list(EndpointListParams params)
-
list
CompletableFuture<Void> list(RequestOptions requestOptions)
-
delete
CompletableFuture<Void> delete(String id)
Soft-deletes a webhook endpoint. Delivery stops immediately and the endpoint no longer appears in list results. Delivery history is preserved (and can be fetched via GET /deliveries with the endpoint_id filter) so audit trails and post-mortem debugging remain possible.
-
delete
CompletableFuture<Void> delete(String id, EndpointDeleteParams params, RequestOptions requestOptions)
-
delete
CompletableFuture<Void> delete(String id, EndpointDeleteParams params)
-
delete
abstract CompletableFuture<Void> delete(EndpointDeleteParams params, RequestOptions requestOptions)
-
delete
CompletableFuture<Void> delete(EndpointDeleteParams params)
-
delete
CompletableFuture<Void> delete(String id, RequestOptions requestOptions)
-
rotateSecret
CompletableFuture<Void> rotateSecret(String id)
Generates a new signing secret for the endpoint. The previous secret remains valid until
previousSecretExpiresInSecelapses (default 24h, max 30 days). During the grace window deliveries are signed with both secrets so receivers can migrate without downtime. Returns the new secret — this is the only time it is shown in plaintext.
-
rotateSecret
CompletableFuture<Void> rotateSecret(String id, EndpointRotateSecretParams params, RequestOptions requestOptions)
-
rotateSecret
CompletableFuture<Void> rotateSecret(String id, EndpointRotateSecretParams params)
-
rotateSecret
abstract CompletableFuture<Void> rotateSecret(EndpointRotateSecretParams params, RequestOptions requestOptions)
-
rotateSecret
CompletableFuture<Void> rotateSecret(EndpointRotateSecretParams params)
-
rotateSecret
CompletableFuture<Void> rotateSecret(String id, RequestOptions requestOptions)
-
test
CompletableFuture<Void> test(String id)
Synchronously delivers a synthetic
webhook.testevent to the endpoint and returns the HTTP result. No retries. Useful for validating that a new endpoint is reachable and its signature verifier works. The delivery is not persisted in the delivery history.
-
test
CompletableFuture<Void> test(String id, EndpointTestParams params, RequestOptions requestOptions)
-
test
CompletableFuture<Void> test(String id, EndpointTestParams params)
-
test
abstract CompletableFuture<Void> test(EndpointTestParams params, RequestOptions requestOptions)
-
test
CompletableFuture<Void> test(EndpointTestParams params)
-
test
CompletableFuture<Void> test(String id, RequestOptions requestOptions)
-
-
-
-