Package ai.extend.resources.webhookendpoints

Class WebhookEndpointsClient

java.lang.Object

ai.extend.resources.webhookendpoints.WebhookEndpointsClient

public class WebhookEndpointsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
WebhookEndpointsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
WebhookEndpointCreate	create(WebhookEndpointsCreateRequest request)	Create a new webhook endpoint.
WebhookEndpointCreate	create(WebhookEndpointsCreateRequest request, RequestOptions requestOptions)	Create a new webhook endpoint.
WebhookEndpointsDeleteResponse	delete(java.lang.String id)	Delete a webhook endpoint and all of its subscriptions.
WebhookEndpointsDeleteResponse	delete(java.lang.String id, RequestOptions requestOptions)	Delete a webhook endpoint and all of its subscriptions.
WebhookEndpointsDeleteResponse	delete(java.lang.String id, WebhookEndpointsDeleteRequest request)	Delete a webhook endpoint and all of its subscriptions.
WebhookEndpointsDeleteResponse	delete(java.lang.String id, WebhookEndpointsDeleteRequest request, RequestOptions requestOptions)	Delete a webhook endpoint and all of its subscriptions.
WebhookEndpointsListResponse	list()	List all webhook endpoints.
WebhookEndpointsListResponse	list(RequestOptions requestOptions)	List all webhook endpoints.
WebhookEndpointsListResponse	list(WebhookEndpointsListRequest request)	List all webhook endpoints.
WebhookEndpointsListResponse	list(WebhookEndpointsListRequest request, RequestOptions requestOptions)	List all webhook endpoints.
WebhookEndpoint	retrieve(java.lang.String id)	Retrieve a webhook endpoint by ID.
WebhookEndpoint	retrieve(java.lang.String id, RequestOptions requestOptions)	Retrieve a webhook endpoint by ID.
WebhookEndpoint	retrieve(java.lang.String id, WebhookEndpointsRetrieveRequest request)	Retrieve a webhook endpoint by ID.
WebhookEndpoint	retrieve(java.lang.String id, WebhookEndpointsRetrieveRequest request, RequestOptions requestOptions)	Retrieve a webhook endpoint by ID.
WebhookEndpoint	update(java.lang.String id)	Update a webhook endpoint.
WebhookEndpoint	update(java.lang.String id, RequestOptions requestOptions)	Update a webhook endpoint.
WebhookEndpoint	update(java.lang.String id, WebhookEndpointsUpdateRequest request)	Update a webhook endpoint.
WebhookEndpoint	update(java.lang.String id, WebhookEndpointsUpdateRequest request, RequestOptions requestOptions)	Update a webhook endpoint.
RawWebhookEndpointsClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

WebhookEndpointsClient

public WebhookEndpointsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawWebhookEndpointsClient withRawResponse()

Get responses with HTTP metadata like headers

list

public WebhookEndpointsListResponse list()

List all webhook endpoints.

list

public WebhookEndpointsListResponse list(RequestOptions requestOptions)

List all webhook endpoints.

list

public WebhookEndpointsListResponse list(WebhookEndpointsListRequest request)

List all webhook endpoints.

list

public WebhookEndpointsListResponse list(WebhookEndpointsListRequest request,
                                         RequestOptions requestOptions)

List all webhook endpoints.

create

public 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 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 WebhookEndpoint retrieve(java.lang.String id)

Retrieve a webhook endpoint by ID.

retrieve

public WebhookEndpoint retrieve(java.lang.String id,
                                RequestOptions requestOptions)

Retrieve a webhook endpoint by ID.

retrieve

public WebhookEndpoint retrieve(java.lang.String id,
                                WebhookEndpointsRetrieveRequest request)

Retrieve a webhook endpoint by ID.

retrieve

public WebhookEndpoint retrieve(java.lang.String id,
                                WebhookEndpointsRetrieveRequest request,
                                RequestOptions requestOptions)

Retrieve a webhook endpoint by ID.

update

public 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 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 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 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 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 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.

delete

public WebhookEndpointsDeleteResponse delete(java.lang.String id,
                                             WebhookEndpointsDeleteRequest request)

Delete a webhook endpoint and all of its subscriptions. This operation is permanent and cannot be undone.

delete

public WebhookEndpointsDeleteResponse delete(java.lang.String id,
                                             WebhookEndpointsDeleteRequest request,
                                             RequestOptions requestOptions)

Delete a webhook endpoint and all of its subscriptions. This operation is permanent and cannot be undone.