Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Connect SDK (advanced)

You probably don’t need this page. Most integrator UIs only need Connect SDK — connectFromSession() with list, link, completeLink, status, tools, and unlink.
The advanced surface is IntegrationsClient on @auvy-synapse/connect-client/advanced (or connect.advanced from the public client).

​
Import

import {
  createAUVYConnectClient,
  resolveConnectPublicUrlFromEnv,
} from '@auvy-synapse/connect-client/advanced'

const { integrations } = createAUVYConnectClient({
  baseUrl: resolveConnectPublicUrlFromEnv(),
  publishableKey: process.env.AUVY_PUBLISHABLE_KEY!,
  getAccessToken: () => session.access_token,
})

await integrations.listScheduledTriggers(integrationId)

​
Method groups

​
CRUD

MethodRoute
listGET /v1/integrations
getGET /v1/integrations/:id
createPOST /v1/integrations
updatePUT /v1/integrations/:id
deleteDELETE /v1/integrations/:id

​
Tools

MethodPurpose
getToolsTools for one integration
getAllToolsAggregate tools across integrations
listToolsBrowse tools catalog
searchToolsSearch tools by query
refreshToolsEnqueue tool refresh
getConnectConnectorsBundled connector ids

​
OAuth and connections

MethodPurpose
connectStart OAuth (maps to public link())
completeConnectOAuth callback (maps to public completeLink())
disconnectDisconnect (maps to public unlink())
getConnectionStatusStatus (maps to public status())
listAccountsConnected accounts
selectAccountSelect active account
connectMicrosoftPlatformMultiSingle OAuth for multiple Microsoft rows
getMicrosoftDelegatedAdminConsentUrlTenant admin consent URL
getAuthConfigDetailsComposio auth config details

​
Triggers

MethodPurpose
getTriggersTrigger definitions for integration
createScheduledTriggerCron-style scheduled trigger
listScheduledTriggersList scheduled triggers
resetScheduledTriggerReset trigger cursor
deleteScheduledTriggerDelete scheduled trigger
enableTriggerSubscriptionEnable Composio/bundled subscription
disableTriggerSubscriptionDisable subscription
renewTriggerSubscriptionRenew expiring subscription
listTriggerTypesBrowse Composio trigger types
getTriggerTypeBySlugGet trigger type by slug
upsertTriggerInstanceCreate/update trigger instance

​
Platform

MethodPurpose
getConnectIntegrationSummaryLightweight summary
getConnectIntegrationSummariesBatchBatch summaries
previewOpenApiPreview OpenAPI-derived integration

​
Credentials (nested)

Access via integrations.credentials.*:
  • list, create, update, delete

​
OAuth apps (nested)

Access via integrations.oauthApps.*:
  • list, create, update, enable, disable, rotateSecret

​
Server execute

Workers and API services run tools with the server subpath (internal secret, not browser JWT): 
import { connectRunTool } from '@auvy-synapse/connect-client/server'

await connectRunTool({
  workspaceId,
  userId,
  integrationId,
  toolName: 'slack_post_message',
  toolConfig: { channel: 'C123', text: 'Hello' },
  resultFormat: 'json',
})
connectRunTool is an alias for connectExecute. Set AUVY_CONNECT_INTERNAL_SECRET and AUVY_CONNECT_URL.