Skip to content

Integration with Third-party Services

Overview

The Integrations feature allows you to connect the Agent Platform to third-party services and use their features seamlessly within your account. This extends the platform’s capabilities to leverage these services and build high-quality AI applications. Once you add a connection for an integration, you can link it to the Integration node in the Tool Flow canvas. This allows you to seamlessly use third-party services while building your tool automation. Learn more about the Integration node.

The Agent Platform supports over 120 integrations across various categories. Each integration is secured by an authorization mechanism supported by the third-party service, which validates the user’s identity before accessing account resources, such as apps or files. The three primary auth methods supported for integrations include:

  • API: A simple token is passed in the request (usually in headers or query parameters) to authenticate the user or app trying to access an API.

  • OAuth2: Uses the OAuth2 industry-standard authorization framework to grant limited access to resources on a service without sharing passwords. The auth method uses the following concepts:

    • Access Token: A temporary token that the app uses to access the user’s resources.
    • Scopes: Permissions tied to the token (e.g., "read email", "write files").
    • Expires: Tokens often have a time limit for security.
    • Refresh Token: A token used to get a new access token when the old one expires.
    • Bearer: API authentication where the client sends a token (called a bearer token) in the request header to access protected resources after a successful login or authorization (usually via OAuth 2.0). The server checks the token to verify if the request is allowed.

    Note

    • Other authentication methods supported for specific integrations include Basic, Basic with JWT, OAuth1, and custom authentication defined by the service provider.
    • Some providers may support multiple authentication methods, allowing flexibility based on your integration needs

Access Integrations

To access the feature, navigate to the Settings console and click Integrations on the left navigation menu. access integrations

Key Features

The features supported on the Integrations page include:

  • All Integrations and Connected Tabs

    Click the All Integrations tab to view the list of available integrations based on the category you choose, and add a connection using the supported auth method. Some of the AI-based integrations include AWS S3 Bucket, Weight & Biases, and Hugging Face.

    Once a service connection is configured and established, the integration appears in the Connected section and is removed from the All Integrations list. If you delete the connection, the integration will be listed again under All Integrations. all integrations

  • Search Integration: Enter the integration name in the Search field to find it in the list. Results will appear for both full and partial matches. search integration

  • Category Dropdown List: The Agent Platform supports multiple categories based on the purpose of the integration, such as AI and Machine Learning, Marketing and Social Media, E-commerce, and more. Select the relevant category or categories in the list and click Apply to view the corresponding integrations. change category

  • Authorization Dropdown List: The available types for authentication methods are API, OAuth2, and Bearer. Refer to the introduction section of this page for more details. Select the required option(s) and click Apply to view the relevant integrations. select auth

  • List View: Click this icon to view the available integration options as a list with the following information:

    • Connection Name: The service provider’s name.
    • Description: A brief description of the purpose or type of integration.
    • Type: The authorization method.list view

  • Tile View: This is the default view. Click this icon to view all the integrations as individual cards. tile view

Add Connection to Set Up Integration

To add a connection or configure an integration, follow the steps below:

Note

You can also add a connection directly from the Integration node on the Tool Flow canvas. Learn more.

  1. Access the Integrations page.

  2. Case 1: To select a service provider connection for the first time, follow these steps:

    • (Optional) In the All Integrations tab, select the Category and Authorization from the respective lists to filter the integration options.
    • Click the required integration tile/listing.

    Case 2: To select an existing/connected provider, click the Connected tab, and click the required provider.

  3. Click Add Connection on the next page or the integrations listing page. add connection connected integration

  4. The Configuration window is displayed, where you must enter the following information:

    • Connection Name: A unique name to identify the integration.

    • Authorization Details

      • Configure the required authorization details in this section to securely connect to the tool and access external services. A provider may support more than one auth type. In this case, you must select the authentication type you want to set up for the integration, such as OAuth2, Bearer Token, or API.

      Note

      You are allowed to select only one auth type for a connection.

      • The Pre-authorize the integration option is auto-selected, indicating that you must provide authentication credentials to interact with the tool or service. You can select the preferred authentication method, such as OAuth2 or Bearer from the available options to configure the credentials.

      • Based on the selected authorization method, the relevant configuration fields automatically appear under each corresponding authorization type.

      OAuth2

      • Provide the connection name and select the configured Auth Profile from the list in the Custom window to associate it with the integration for authentication. Learn more about setting up auth profiles in your account. If no auth profiles are configured, you can add one by selecting + Create new and following the steps mentioned here.
      • Custom auth allows you to use your custom-configured authentication flow by selecting an Auth Profile on the Agent Platform, instead of using third-party authentication.
      • Once an Auth Profile is selected, all its credentials are fetched and automatically populate the corresponding fields such as Redirect URL, Scopes, Base URL, and more.
      • You don’t need to re-authenticate as long as the authorization profile remains in your account (i.e., it hasn’t been deleted).
      • If you attempt to connect to a provider using a deleted auth profile, an error will occur.
      • When configuring a connection after an auth profile has been deleted, it will no longer appear in the Custom window.
      • Click Authorize to test the integration for the selected Auth profile. click authorize

      Bearer Token

      • When you select this auth type, you must enter the bearer token along with related information such as the Base URL, API Key, Bot Token, or other relevant credentials.
      • The required fields depend on the bearer authentication framework supported by the selected service provider.
      • You can retrieve (copy and paste) these values from the Admin console > Settings section of your account on the provider’s site.
      • Click Test to validate the connection. A success message is displayed once the connection is set up. test oauth

      API

      • When you select this type, you must enter the API Key or Access Token for the service provider.
      • Additional field inputs may be required based on the specific parameters needed to configure the provider.
      • You can retrieve (copy and paste) these values from the admin console > Settings section of your account on the provider’s site.
      • Click Test to validate the connection. A success message is displayed once the connection is set up. test validation

    Note

    For other Authentication types, such as OAuth1, retrieve the required values from the admin console of your account on the provider’s site to configure the integration.

  1. Click Save.

    2. Note

    The Save button will not appear until all required inputs have been provided.

Once the connection is set up, a success message is displayed.

You will be redirected to the following page, where all the connections for the provider are listed. integration summary

Manage Connection Errors

  • During or after setting up a connection, errors may occur while testing. These errors are often caused by invalid credentials provided during the configuration (add a connection step).

  • View the error

    • Navigate to the Connected section.
    • Select the connection.
    • Click the Play icon to test the connection.
    • Hover over the warning sign, which will display the reason for the issue. hover over error icon

    You can also click Edit, go to the configuration window, and click Test to view the error.

    view error

  • Resolve the error

    • Use the Edit functionality to provide the correct credentials in the configuration window.
    • Click Test to validate the connection.
    • Click Save.

Manage Connected Integrations

You can view, edit, delete, and perform additional actions with connected integrations to your account in the Connected section. click connected tab

View Summary

Once you click the integration in the Connected section, the list of configured connections is displayed with the following information:

  • Connection Name: The unique name provided during the connection setup.
  • Added By: The name of the admin/account user who added the connection.
  • Authorization Details: Pre-authorize is displayed.
  • Integration Type: API, OAuth2, Bearer, etc., based on the type used.
  • Added on: The date when the connection was added.
  • Action: Allows you to test the connection or enable/disable it.

view summary

Edit Integration

To edit the configuration for a connection, follow the steps below:

Note

You cannot modify the connection name.

  1. Access the Integrations page.
  2. Click the Connected tab and select a connection.

  3. Click the Ellipses icon for the required connection. select edit integration

  4. Select Edit.

  5. In the configuration window, modify the required fields in the Authorization Details section.
  6. (Optional) Click Test to validate the connection.
  7. Click Save.

save edited integration

A success message is displayed once the connection is updated. edit success message

Delete Integration

To delete an integration, follow the steps below:

  1. Access the Integrations page.
  2. Click the Connected tab and select a connection.
  3. Click the Ellipses icon for the required connection.

  4. Select Delete. select delete

  5. Click Delete in the confirmation dialog.

Caution

This action is irreversible and will remove all associations of the connection from the Agent Platform.

delete connection

A success message appears, and the connection is removed from the system.

Test Connection

To test a configured connection, follow the steps below:

  1. Access the Integrations page.
  2. Click the Connected tab and select a connection.
  3. Click the Play icon for the required connection. test action

The connection is validated in the background, and any errors are highlighted with a warning icon. Learn more about managing errors.

manage error

If there are no errors, a success message is displayed when the connection is established.

Enable or Disable Connection

Enabling a connection makes it available for user authentication with the service provider. It also becomes accessible for use in the Integration node on the Tool Flow canvas.

Use the toggle switch to enable (default setting) or disable the connection as needed. enable integration