AeontelAeontel Docs

Webhook Endpoints hooks

Hand-written shim. Implementation is generated; see ./webhook-endpoints.gen.

Hooks

useCreateWebhookEndpoint mutation

Create a new webhook endpoint.

TypeScript
useCreateWebhookEndpoint(options?: MutationOpts<WebhookEndpoint, CreateWebhookEndpointParams>)

Types: WebhookEndpoint · CreateWebhookEndpointParams

useDeleteWebhookEndpoint mutation

Soft-delete a webhook endpoint.

TypeScript
useDeleteWebhookEndpoint(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useListWebhookEndpoints query

List webhook endpoints with pagination.

TypeScript
useListWebhookEndpoints(params?: Omit<ListWebhookEndpointsParams, | > & { filter?: WebhookEndpointFilter; orderBy?: WebhookEndpointOrderBy[]; } & WebhookEndpointShorthands, options?: QueryOpts<Page<WebhookEndpoint>>)

Types: ListWebhookEndpointsParams · WebhookEndpointFilter · WebhookEndpointOrderBy · WebhookEndpointShorthands · Page · WebhookEndpoint

usePurgeWebhookEndpoint composite

Permanently delete a soft-deleted webhook endpoint.

TypeScript
usePurgeWebhookEndpoint(options?: MutationOpts<SuccessResponse, PurgeWebhookEndpointParams>)

Types: SuccessResponse · PurgeWebhookEndpointParams

useRestoreWebhookEndpoint composite

Restore a soft-deleted webhook endpoint.

TypeScript
useRestoreWebhookEndpoint(options?: MutationOpts<WebhookEndpoint, string>)

Types: WebhookEndpoint

useRetrieveWebhookEndpoint query

Get a single webhook endpoint by ID.

TypeScript
useRetrieveWebhookEndpoint(id: string, options?: QueryOpts<WebhookEndpoint>)

Types: WebhookEndpoint

useUpdateWebhookEndpoint mutation

Update a webhook endpoint.

TypeScript
useUpdateWebhookEndpoint(options?: MutationOpts<WebhookEndpoint, UpdateWebhookEndpointParams>)

Types: WebhookEndpoint · UpdateWebhookEndpointParams