Connecting to Gmail

Gmail is Google's free web-based email service that provides storage for emails, chat, and archiving.

To integrate Gmail with IBM watsonx Orchestrate, you need to establish a secure connection that enables both systems to communicate seamlessly. For general guidance on managing integrations, refer to Connecting apps for prebuilt agents.

Note:

The Single sign-on (SSO) toggle is enabled only for supported OAuth 2.0 authentication types and applications. If the application does not support an SSO-enabled authentication type, the toggle remains disabled. For supported configurations, see Configuring single sign-on for applications.

Steps to connect

Use the following steps to connect Gmail to watsonx Orchestrate:

Go to Manage > Connections and search for the corresponding app name or Gmail Connection ID.
Click edit next to the matching connection ID.
Select Key Value Pair as the authentication type.
Enter the Gmail‑specific fields described in the connection details section. See Connecting apps for prebuilt agents page for general connection workflow.
Complete the Draft and Live setup steps.
Save and test the connection to confirm successful connection.

Authentication methods

Gmail supports the following authentication type in watsonx Orchestrate:

Key Value Pair (KVP): Required for API‑key or token‑based configurations

Connection ID

Use the following Connection ID when locating your Gmail connection in the Connections settings page. To understand how to search for a Connection ID and open a connection for editing, see Connecting apps for prebuilt agents.


Authentication type	Connection ID
Key Value Pair	`google_key_value_ibm_184bdbd3`

Key Value Pair connection details

If your organization uses token‑based authentication, set Authentication type to Key Value Pair and add each of the following fields using Add new field:


Field	Description
`base_url`	The base URL for Gmail API (for example, `https://gmail.googleapis.com/`)
`token_url`	The URL used to obtain the OAuth token (for example, `https://oauth2.googleapis.com/token`)
`client_id`	Your Google Cloud project's client ID
`client_secret`	Your Google Cloud project's client secret
`bearer_token`	The access token used for API requests
`refresh_token`	The token used to refresh the bearer token when it expires

Note: When using Key Value Pair, only Team credentials are supported.

To get these values, see the Google Authentication API documentation.

What to do next

Now that your app connection is live, you can start using it in watsonx Orchestrate.

Run an agent in Orchestrate Chat to complete tasks using natural language. See Using Orchestrate Chat for more details.
Use relevant agents and tools to perform app-specific actions. See Prebuilt agents and Prebuilt tools for more details.