AeontelAeontel Docs

Webhook Subscriptions hooks

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

Hooks

useCreateWebhookSubscription mutation

Create a new webhook subscription.

TypeScript
useCreateWebhookSubscription(options?: MutationOpts<WebhookSubscription, CreateWebhookSubscriptionParams>)

Types: WebhookSubscription · CreateWebhookSubscriptionParams

useDeleteWebhookSubscription mutation

Soft-delete a webhook subscription.

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

Types: SuccessResponse

useListWebhookSubscriptions query

List webhook subscriptions.

TypeScript
useListWebhookSubscriptions(params?: Omit<ListWebhookSubscriptionsParams, | > & { filter?: WebhookSubscriptionFilter; orderBy?: WebhookSubscriptionOrderBy[]; } & WebhookSubscriptionShorthands, options?: QueryOpts<Page<WebhookSubscription>>)

Types: ListWebhookSubscriptionsParams · WebhookSubscriptionFilter · WebhookSubscriptionOrderBy · WebhookSubscriptionShorthands · Page · WebhookSubscription

usePurgeWebhookSubscription composite

Permanently delete a soft-deleted webhook subscription.

TypeScript
usePurgeWebhookSubscription(options?: MutationOpts<SuccessResponse, PurgeWebhookSubscriptionParams>)

Types: SuccessResponse · PurgeWebhookSubscriptionParams

useRestoreWebhookSubscription composite

Restore a soft-deleted webhook subscription.

TypeScript
useRestoreWebhookSubscription(options?: MutationOpts<WebhookSubscription, string>)

Types: WebhookSubscription

useRetrieveWebhookSubscription query

Get a single webhook subscription by ID.

TypeScript
useRetrieveWebhookSubscription(id: string, options?: QueryOpts<WebhookSubscription>)

Types: WebhookSubscription

useUpdateWebhookSubscription mutation

Update a webhook subscription.

TypeScript
useUpdateWebhookSubscription(options?: MutationOpts<WebhookSubscription, UpdateWebhookSubscriptionParams>)

Types: WebhookSubscription · UpdateWebhookSubscriptionParams