AeontelAeontel Docs

Integrations hooks

Hand-written shim. Generated CRUD hooks via ./integrations.gen. Custom-op hooks (publish, listVersions, install) stay hand-written until the React gen learns to emit kind: "custom" ops.

Hooks

useCreateIntegration mutation

Create a draft integration in the source workspace.

TypeScript
useCreateIntegration(options?: MutationOpts<Integration, CreateIntegrationParams>)

Types: Integration · CreateIntegrationParams

useDeleteIntegration mutation

Soft-delete the integration. Existing installs keep working — they pin to an immutable integration_version.

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

Types: SuccessResponse

useInstallIntegration composite

TypeScript
useInstallIntegration(options?: MutationOpts<IntegrationInstall, InstallIntegrationParams>)

Types: IntegrationInstall · InstallIntegrationParams

useInstallMembers composite

TypeScript
useInstallMembers(params: InstallMembersParams, options?: QueryOpts<InstallMembersResponse>)

Types: InstallMembersParams · InstallMembersResponse

useIntegrationMembers composite

TypeScript
useIntegrationMembers(params: IntegrationMembersParams, options?: QueryOpts<IntegrationMembersResponse>)

Types: IntegrationMembersParams · IntegrationMembersResponse

useListIntegrations query

List integrations.

TypeScript
useListIntegrations(params?: Omit<ListIntegrationsParams, | > & { filter?: IntegrationFilter; orderBy?: IntegrationOrderBy[]; } & IntegrationShorthands, options?: QueryOpts<Page<Integration>>)

Types: ListIntegrationsParams · IntegrationFilter · IntegrationOrderBy · IntegrationShorthands · Page · Integration

usePublishIntegration composite

TypeScript
usePublishIntegration(options?: MutationOpts<IntegrationVersion, PublishIntegrationParams>)

Types: IntegrationVersion · PublishIntegrationParams

usePurgeIntegration composite

Permanently delete a soft-deleted integration.

TypeScript
usePurgeIntegration(options?: MutationOpts<SuccessResponse, PurgeIntegrationParams>)

Types: SuccessResponse · PurgeIntegrationParams

useRestoreIntegration composite

Restore a soft-deleted integration.

TypeScript
useRestoreIntegration(options?: MutationOpts<Integration, string>)

Types: Integration

useRetrieveIntegration query

Get an integration by ID.

TypeScript
useRetrieveIntegration(id: string, options?: QueryOpts<Integration>)

Types: Integration

useSetMemberDetached composite

TypeScript
useSetMemberDetached(options?: MutationOpts<SuccessResponse, SetMemberDetachedParams>)

Types: SuccessResponse · SetMemberDetachedParams

useUpdateIntegration mutation

Update the draft integration's metadata or manifest.

TypeScript
useUpdateIntegration(options?: MutationOpts<Integration, UpdateIntegrationParams>)

Types: Integration · UpdateIntegrationParams

useUpgradeIntegrationInstall composite

TypeScript
useUpgradeIntegrationInstall(options?: MutationOpts<IntegrationUpgradeResult, UpgradeIntegrationInstallParams>)

Types: IntegrationUpgradeResult · UpgradeIntegrationInstallParams