Constructor Detail

Method Detail

• withRawResponse

   abstract EndpointService.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract EndpointService withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• create

   Unit 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 Unit create(EndpointCreateParams params, RequestOptions requestOptions)

• retrieve

   Unit retrieve(String id)

  Get webhook endpoint

• retrieve

   Unit retrieve(String id, EndpointRetrieveParams params, RequestOptions requestOptions)

• retrieve

   Unit retrieve(String id, EndpointRetrieveParams params)

• retrieve

   abstract Unit retrieve(EndpointRetrieveParams params, RequestOptions requestOptions)

• retrieve

   Unit retrieve(EndpointRetrieveParams params)

• retrieve

   Unit retrieve(String id, RequestOptions requestOptions)

• update

   Unit 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

   Unit update(String id, EndpointUpdateParams params, RequestOptions requestOptions)

• update

   Unit update(String id, EndpointUpdateParams params)

• update

   abstract Unit update(EndpointUpdateParams params, RequestOptions requestOptions)

• update

   Unit update(EndpointUpdateParams params)

• update

   Unit update(String id, RequestOptions requestOptions)

• list

   Unit list()

  Returns the organization's webhook endpoints, newest first. Signing secrets are never included.

• list

   abstract Unit list(EndpointListParams params, RequestOptions requestOptions)

• list

   Unit list(EndpointListParams params)

• list

   Unit list(RequestOptions requestOptions)

• delete

   Unit 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

   Unit delete(String id, EndpointDeleteParams params, RequestOptions requestOptions)

• delete

   Unit delete(String id, EndpointDeleteParams params)

• delete

   abstract Unit delete(EndpointDeleteParams params, RequestOptions requestOptions)

• delete

   Unit delete(EndpointDeleteParams params)

• delete

   Unit delete(String id, RequestOptions requestOptions)

• rotateSecret

   Unit rotateSecret(String id)

  Generates a new signing secret for the endpoint. The previous secret remains valid until previousSecretExpiresInSec elapses (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

   Unit rotateSecret(String id, EndpointRotateSecretParams params, RequestOptions requestOptions)

• rotateSecret

   Unit rotateSecret(String id, EndpointRotateSecretParams params)

• rotateSecret

   abstract Unit rotateSecret(EndpointRotateSecretParams params, RequestOptions requestOptions)

• rotateSecret

   Unit rotateSecret(EndpointRotateSecretParams params)

• rotateSecret

   Unit rotateSecret(String id, RequestOptions requestOptions)

• test

   Unit test(String id)

  Synchronously delivers a synthetic webhook.test event 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

   Unit test(String id, EndpointTestParams params, RequestOptions requestOptions)

• test

   Unit test(String id, EndpointTestParams params)

• test

   abstract Unit test(EndpointTestParams params, RequestOptions requestOptions)

• test

   Unit test(EndpointTestParams params)

• test

   Unit test(String id, RequestOptions requestOptions)