Skip to main content
IntegrationsResource is reachable on every Kataven Node client as client.integrations. Each method maps to one HTTP endpoint on the Hub API; links to the underlying spec entry are inline below. Third-party integrations bundle a set of tools + required credentials (encrypted via Secret Encryptor). Install once per account.

Methods at a glance

MethodHTTPSummary
listGET /api/integrationsList third-party integrations
getGET /api/integrations/{id}Get a single integration
installPOST /api/integrations/{id}/installInstall an integration
uninstallPOST /api/integrations/{id}/uninstallUninstall an integration

Reference

client.integrations.list(...)

List third-party integrations HTTPGET /api/integrations · API reference →
list(opts: { category?: string; status?: string } = {})
Returns the catalog of third-party integrations (Stripe, Shopify, …) for this tenant. Includes per-category counts.

client.integrations.get(...)

Get a single integration HTTPGET /api/integrations/{id} · API reference →
get(id: string)

client.integrations.install(...)

Install an integration HTTPPOST /api/integrations/{id}/install · API reference →
install(id: string, params: Record<string, string> = {}, secrets: Record<string, string> = {})
Stores params (plaintext) and secrets (encrypted) supplied by the caller, then flips the integration row’s status to ‘installed’. Empty body installs without params.

client.integrations.uninstall(...)

Uninstall an integration HTTPPOST /api/integrations/{id}/uninstall · API reference →
uninstall(id: string)
Flips status back to ‘available’ and clears installed_at. Stored params/secrets are NOT purged.