Class AsyncWebhookEndpointsClient


  • public class AsyncWebhookEndpointsClient
    extends java.lang.Object
    • Constructor Detail

      • AsyncWebhookEndpointsClient

        public AsyncWebhookEndpointsClient​(ClientOptions clientOptions)
    • Method Detail

      • create

        public java.util.concurrent.CompletableFuture<WebhookEndpointCreate> create​(WebhookEndpointsCreateRequest request)
        Create a new webhook endpoint. The response includes a signingSecret that is only returned once — store it securely for verifying webhook signatures.

        The enabledEvents array specifies which global event types this endpoint should receive. Use the Webhook Events reference to see available event types.

        To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use Create Webhook Subscription after creating the endpoint.

      • create

        public java.util.concurrent.CompletableFuture<WebhookEndpointCreate> create​(WebhookEndpointsCreateRequest request,
                                                                                    RequestOptions requestOptions)
        Create a new webhook endpoint. The response includes a signingSecret that is only returned once — store it securely for verifying webhook signatures.

        The enabledEvents array specifies which global event types this endpoint should receive. Use the Webhook Events reference to see available event types.

        To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use Create Webhook Subscription after creating the endpoint.

      • retrieve

        public java.util.concurrent.CompletableFuture<WebhookEndpoint> retrieve​(java.lang.String id)
        Retrieve a webhook endpoint by ID.
      • retrieve

        public java.util.concurrent.CompletableFuture<WebhookEndpoint> retrieve​(java.lang.String id,
                                                                                RequestOptions requestOptions)
        Retrieve a webhook endpoint by ID.
      • update

        public java.util.concurrent.CompletableFuture<WebhookEndpoint> update​(java.lang.String id)
        Update a webhook endpoint. Only the fields you include in the request body will be updated; omitted fields remain unchanged.

        The apiVersion of a webhook endpoint cannot be changed after creation.

      • update

        public java.util.concurrent.CompletableFuture<WebhookEndpoint> update​(java.lang.String id,
                                                                              RequestOptions requestOptions)
        Update a webhook endpoint. Only the fields you include in the request body will be updated; omitted fields remain unchanged.

        The apiVersion of a webhook endpoint cannot be changed after creation.

      • update

        public java.util.concurrent.CompletableFuture<WebhookEndpoint> update​(java.lang.String id,
                                                                              WebhookEndpointsUpdateRequest request)
        Update a webhook endpoint. Only the fields you include in the request body will be updated; omitted fields remain unchanged.

        The apiVersion of a webhook endpoint cannot be changed after creation.

      • update

        public java.util.concurrent.CompletableFuture<WebhookEndpoint> update​(java.lang.String id,
                                                                              WebhookEndpointsUpdateRequest request,
                                                                              RequestOptions requestOptions)
        Update a webhook endpoint. Only the fields you include in the request body will be updated; omitted fields remain unchanged.

        The apiVersion of a webhook endpoint cannot be changed after creation.

      • delete

        public java.util.concurrent.CompletableFuture<WebhookEndpointsDeleteResponse> delete​(java.lang.String id)
        Delete a webhook endpoint and all of its subscriptions. This operation is permanent and cannot be undone.
      • delete

        public java.util.concurrent.CompletableFuture<WebhookEndpointsDeleteResponse> delete​(java.lang.String id,
                                                                                             RequestOptions requestOptions)
        Delete a webhook endpoint and all of its subscriptions. This operation is permanent and cannot be undone.