SDK: connectors

The connectors area has 14 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

connectorsAction

Run a connector action; a write or destructive action follows the autonomy class it declares

• Request: POST on /v1/tenants/{tenantId}/connectors/{provider}/actions/{action}

connectorsAction(args: { tenantId: string; provider: string; action: string; body: RunConnectorActionRequest }, options?: CallOptions): Promise<ConnectorActionResult>

connectorsApprovalsRequest

Post an approval request to a chat connector’s channel

• Request: POST on /v1/tenants/{tenantId}/connectors/{provider}/approvals

connectorsApprovalsRequest(args: { tenantId: string; provider: string; body: ChatApprovalRequest }, options?: CallOptions): Promise<ConnectorActionResult>

connectorsChatUsersLink

Link the signed-in member to a chat account with the code the assistant showed there

• Request: POST on /v1/tenants/{tenantId}/connectors/{provider}/chat-users/link

connectorsChatUsersLink(args: { tenantId: string; provider: string; body: LinkChatUserRequest }, options?: CallOptions): Promise<Record<string, unknown>>

connectorsChatUsersMap

Map a chat user to a team member who may answer approvals there (policy class)

• Request: POST on /v1/tenants/{tenantId}/connectors/{provider}/chat-users
• Needs an approval for agents: class policy_change

connectorsChatUsersMap(args: { tenantId: string; provider: string; body: MapChatUserRequest }, options?: CallOptions): Promise<Record<string, unknown>>

connectorsConnect

Store a connector credential in the tenant vault (secrets class)

• Request: POST on /v1/tenants/{tenantId}/connectors/connections
• Needs an approval for agents: class secrets

connectorsConnect(args: { tenantId: string; body: StoreCredentialRequest }, options?: CallOptions): Promise<ConnectorConnection>

connectorsConnectionsList

The team’s connections; a connection shows its vault entry, never the secret

• Request: GET on /v1/tenants/{tenantId}/connectors/connections

connectorsConnectionsList(args: { tenantId: string }, options?: CallOptions): Promise<ConnectionList>

connectorsEvents

Verified inbound events from a connector, each labelled as data

• Request: GET on /v1/tenants/{tenantId}/connectors/{provider}/events

connectorsEvents(args: { tenantId: string; provider: string; query?: { limit?: string } }, options?: CallOptions): Promise<ConnectorEventList>

connectorsList

The connectors Overlane offers, each with its auth, scopes, typed actions and events

• Request: GET on /v1/tenants/{tenantId}/connectors

connectorsList(args: { tenantId: string }, options?: CallOptions): Promise<ConnectorList>

connectorsMcpAdd

Allow a passthrough MCP server (https, public DNS name; policy class)

• Request: POST on /v1/tenants/{tenantId}/connectors/mcp/servers
• Needs an approval for agents: class policy_change

connectorsMcpAdd(args: { tenantId: string; body: AddMcpServerRequest }, options?: CallOptions): Promise<McpAllowlistEntry>

connectorsMcpList

The team’s allowlisted passthrough MCP servers

• Request: GET on /v1/tenants/{tenantId}/connectors/mcp/servers

connectorsMcpList(args: { tenantId: string }, options?: CallOptions): Promise<McpServerList>

connectorsMcpRemove

Remove a passthrough MCP server (policy class)

• Request: DELETE on /v1/tenants/{tenantId}/connectors/mcp/servers/{serverId}
• Needs an approval for agents: class policy_change

connectorsMcpRemove(args: { tenantId: string; serverId: string }, options?: CallOptions): Promise<Record<string, unknown>>

connectorsOauthStart

Start connecting a provider by signing in with it; the answer is the URL to open (secrets class)

• Request: POST on /v1/tenants/{tenantId}/connectors/{provider}/oauth/start
• Needs an approval for agents: class secrets

connectorsOauthStart(args: { tenantId: string; provider: string; body: StartConnectorOAuthRequest }, options?: CallOptions): Promise<ConnectorOAuthStart>

connectorsRevoke

Revoke a connection and delete its stored secret (secrets class)

• Request: DELETE on /v1/tenants/{tenantId}/connectors/connections/{connectionId}
• Needs an approval for agents: class secrets

connectorsRevoke(args: { tenantId: string; connectionId: string }, options?: CallOptions): Promise<ConnectorConnection>

connectorsShow

One connector’s declaration

• Request: GET on /v1/tenants/{tenantId}/connectors/{connectorId}

connectorsShow(args: { tenantId: string; connectorId: string }, options?: CallOptions): Promise<ConnectorDeclaration>