> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Integrations

> Manage connections and integrations.

Manage connections and integrations.

Browse the [integration catalog](/docs/cloud/rest/apis/integrations#integrations), configure [a project integration](/docs/cloud/rest/apis/integrations#integrations), and [connect an account](/docs/cloud/rest/apis/integrations#connections). Use that connection to access the service’s tools or data.

[Integrations](#integrations) · [Connections](#connections) · [Channels](#channels) · [External storage](#external-storage)

## Integrations

Browse integrations and read their metadata, icons, and connection summaries. Configure project-specific settings through the [project integration endpoints](/docs/cloud/rest/apis/integrations#integrations).

Read, update or reset a project’s settings for an integration, and check whether one of its tools can run. Some integrations also expose service-specific metadata, such as Salesforce objects and fields.

List the integration tools a project can use and run one with the required connection context. The /integrations/tools and /integrations/{integration}/tools paths are deprecated aliases. Manage source-defined tools through the [Agents API](/docs/cloud/rest/apis/agents#tools).

| Endpoint | Methods | Description |
| - | - | - |
| `/integration-tools` | [GET](/docs/cloud/rest/api-reference/integrations-integrations-integration-tools/list-integration-tools) | List integration tools |
| `/integration-tools/{tool_name}/run` | [POST](/docs/cloud/rest/api-reference/integrations-integrations-integration-tools/run-integration-tool) | Run integration tool |
| `/integrations/tools/list` | [POST](/docs/cloud/rest/api-reference/integrations-integrations-integration-tools/list-integration-tools-legacy) (deprecated) | List integration tools (legacy) |
| `/integrations/{integration}/tools` | [GET](/docs/cloud/rest/api-reference/integrations-integrations-integration-tools/list-tools-for-integration) (deprecated) | List tools for integration |
| `/integrations/tools/call` | [POST](/docs/cloud/rest/api-reference/integrations-integrations-integration-tools/call-integration-tool) (deprecated) | Call integration tool |
| `/integrations/{integration}/tools/{tool}/call` | [POST](/docs/cloud/rest/api-reference/integrations-integrations-integration-tools/call-tool-for-integration) (deprecated) | Call tool for integration |
| `/integrations` | [GET](/docs/cloud/rest/api-reference/integrations-integrations-integration-catalog/list-integrations) | List integrations |
| `/integrations/{name}` | [GET](/docs/cloud/rest/api-reference/integrations-integrations-integration-catalog/get-integration) | Get integration |
| `/integrations/{name}/icon` | [GET](/docs/cloud/rest/api-reference/integrations-integrations-integration-catalog/get-integration-icon) | Get integration icon |
| `/projects/{project_reference}/integrations/{name}/readiness` | [GET](/docs/cloud/rest/api-reference/integrations-integrations-project-integrations/check-integration-readiness) | Check integration readiness |
| `/projects/{project_reference}/integrations` | [GET](/docs/cloud/rest/api-reference/integrations-integrations-project-integrations/list-project-integrations) | List project integrations |
| `/projects/{project_reference}/integrations/{name}` | [GET](/docs/cloud/rest/api-reference/integrations-integrations-project-integrations/get-project-integration), [PATCH](/docs/cloud/rest/api-reference/integrations-integrations-project-integrations/update-project-integration), [DELETE](/docs/cloud/rest/api-reference/integrations-integrations-project-integrations/delete-project-integration) | Get project integration; Update project integration; Delete project integration |
| `/projects/{project_reference}/integrations/salesforce/objects` | [GET](/docs/cloud/rest/api-reference/integrations-integrations-project-integrations/list-salesforce-objects) | List Salesforce objects |
| `/projects/{project_reference}/integrations/salesforce/objects/{object_name}/fields` | [GET](/docs/cloud/rest/api-reference/integrations-integrations-project-integrations/list-salesforce-object-fields) | List Salesforce object fields |

## Connections

Connect, check, list, or delete external accounts. Use [sign-in](/docs/cloud/rest/apis/identity-access#authentication) to sign in to Veryfront itself.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/integrations/{name}/connect-sessions` | [POST](/docs/cloud/rest/api-reference/integrations-connections-connections/create-connect-session) | Create connect session |
| `/projects/{project_reference}/integrations/{name}/connection-status` | [GET](/docs/cloud/rest/api-reference/integrations-connections-connections/get-connection-status) | Get connection status |
| `/projects/{project_reference}/integrations/{name}/connections/{connection_id}` | [DELETE](/docs/cloud/rest/api-reference/integrations-connections-connections/delete-connection) | Delete connection |
| `/oauth/connect/{integration}` | [GET](/docs/cloud/rest/api-reference/integrations-connections-connections/start-connecting-an-integration) | Start connecting an integration |
| `/oauth/callback/{integration}` | [GET](/docs/cloud/rest/api-reference/integrations-connections-connections/complete-connecting-an-integration) | Complete connecting an integration |
| `/oauth/connect/session` | [POST](/docs/cloud/rest/api-reference/integrations-connections-connections/create-oauth-connect-session) (deprecated) | Create OAuth connect session |
| `/oauth/status/{integration}` | [GET](/docs/cloud/rest/api-reference/integrations-connections-connections/get-oauth-status) (deprecated) | Get OAuth status |
| `/projects/{project_reference}/connections` | [GET](/docs/cloud/rest/api-reference/integrations-connections-connections/list-connections) | List connections |
| `/connections` | [GET](/docs/cloud/rest/api-reference/integrations-connections-connections/list-connections-across-projects) | List connections across projects |

## Channels

Connect a project agent to a Slack workspace on a runtime target: list, create, read, update, delete or check channels.

List the agents a runtime target can use and the Slack channels the workspace can see, to fill in a channel. The /channels/assistants path is a deprecated alias.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/channels` | [GET](/docs/cloud/rest/api-reference/integrations-channels-channels/list-a-project-s-channels), [POST](/docs/cloud/rest/api-reference/integrations-channels-channels/connect-an-agent-to-a-slack-workspace) | List a project's channels; Connect an agent to a Slack workspace |
| `/projects/{project_reference}/channels/{channel_id}` | [GET](/docs/cloud/rest/api-reference/integrations-channels-channels/read-one-channel-and-its-runtime-target), [PATCH](/docs/cloud/rest/api-reference/integrations-channels-channels/change-a-channel-s-settings-or-target), [DELETE](/docs/cloud/rest/api-reference/integrations-channels-channels/disconnect-a-channel) | Read one channel and its runtime target; Change a channel's settings or target; Disconnect a channel |
| `/projects/{project_reference}/channels/{channel_id}/check` | [POST](/docs/cloud/rest/api-reference/integrations-channels-channels/post-a-test-message-to-verify-delivery) | Post a test message to verify delivery |
| `/projects/{project_reference}/channels/agents` | [GET](/docs/cloud/rest/api-reference/integrations-channels-setup-lookups/list-agents-a-runtime-target-can-use) | List agents a runtime target can use |
| `/projects/{project_reference}/channels/assistants` | [GET](/docs/cloud/rest/api-reference/integrations-channels-setup-lookups/list-target-assistants) (deprecated) | List target assistants |
| `/projects/{project_reference}/channels/slack-channels` | [GET](/docs/cloud/rest/api-reference/integrations-channels-setup-lookups/search-slack-channels-the-workspace-can-see) | Search Slack channels the workspace can see |

## External storage

List, search, read, create, update, move, import, or delete the files in a user's own OneDrive, SharePoint, or Google Drive connection. Use [project files](/docs/cloud/rest/apis/projects#files) for files already stored in a project.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/external-files/{provider}` | [GET](/docs/cloud/rest/api-reference/integrations-external-storage-external-files/list-external-files), [POST](/docs/cloud/rest/api-reference/integrations-external-storage-external-files/create-external-file) | List external files; Create external file |
| `/projects/{project_reference}/external-files/{provider}/{file_id}` | [GET](/docs/cloud/rest/api-reference/integrations-external-storage-external-files/get-external-file), [PUT](/docs/cloud/rest/api-reference/integrations-external-storage-external-files/update-external-file), [DELETE](/docs/cloud/rest/api-reference/integrations-external-storage-external-files/delete-external-file) | Get external file; Update external file; Delete external file |
| `/projects/{project_reference}/external-files/{provider}/{file_id}/content` | [GET](/docs/cloud/rest/api-reference/integrations-external-storage-external-files/read-external-file-content) | Read external file content |
| `/projects/{project_reference}/external-files/{provider}/{file_id}/move` | [POST](/docs/cloud/rest/api-reference/integrations-external-storage-external-files/move-external-file) | Move external file |
| `/projects/{project_reference}/external-files/{provider}/folders` | [POST](/docs/cloud/rest/api-reference/integrations-external-storage-external-files/create-external-folder) | Create external folder |
| `/projects/{project_reference}/external-files/{provider}/{file_id}/import` | [POST](/docs/cloud/rest/api-reference/integrations-external-storage-external-files/import-external-file) | Import external file |

[Back to REST API reference](/docs/cloud/rest)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.