Connecting apps for prebuilt agents

Edit online

Prebuilt agents rely on external applications to perform actions such as retrieving data, initiating workflows, or updating records. When you connect an app, you enable the agent to use that application's APIs to complete the tasks.

Before you configure a connection, review the app's integration page to understand the credential types and configuration requirements for the application.

Supported authentication methods

IBM watsonx Orchestrate supports multiple authentication methods for connecting to external applications. The method you use depends entirely on the requirements of the target app.

For a detailed explanation of each authentication type, see Authentication types overview.

You configure authentication separately in the Draft and Live environments. Some apps require different credential types in each environment (for example, Basic Auth in Draft and an API key in Live).

Some apps may require different authentication methods or scopes in each environment. Refer to the app's integration page for specific requirements.

Connecting to an app

Follow these universal steps to add credentials for any application:

  1. From the main menu, go to Manage > Connections.

  2. Search for the application you want to connect.

  3. Click Edit next to the matching Connection ID.

  4. Select the application you want to connect.

Note:

Each app has a unique Connection ID, provided on that app's integration page. Click edit next to the matching connection ID.

  1. Configure the Draft environment.

    1. Enter the credential fields required by the application (for example, domain, API key, token, OAuth values, or scopes).

    2. If using Team credentials, click Connect to enable access for the entire team.

    3. Click Save.

  2. Configure the Live environment.

    1. Repeat authentication setup for the live environment.

    2. Team‑wide credentials are recommended for production use.

    3. If using Team credentials, click Connect to enable access for the entire team.

A success message confirms that your connection is active.

Draft and live environments

Each app connection includes Draft and Live environments, which must be configured separately.

  • Draft environment: Use for testing and validation. Enter lower‑risk or test credentials to ensure the connection works before moving to production.

  • Live environment: Use for production. Enter full, production‑ready credentials. Agents cannot run in Live mode until this environment is configured.

What to do next

  • Browse the list of supported apps to find the application you want to connect.

  • Open the app's integration page to review its Connection ID, required credential fields, and any setup needed in the external app.

  • Gather the credentials that the app requires, such as API keys, OAuth values, or client secrets.