> ## Documentation Index > Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Set Up Connections > Set up Cashfree Relay connections to link Gmail, Slack, Google Sheets, and other external apps so your automated agents can act on real data. Connections link external apps and services to the Cashfree Merchant Dashboard, enabling agents to perform actions such as sending emails, updating spreadsheets, or posting messages. You must set up a connection before you can use an app-based action in an agent. You manage all connections from the **Connections** tab on the Relay dashboard, and you can reuse them across multiple agents. ## Supported integrations The following integrations are available for use in agents. | Integration | Authentication type | Description | | --------------------- | --------------------------- | ------------------------------------------------------------------------------------ | | Cashfree | Client ID and Client Secret | Process payments using Cashfree. | | Cashfree Payouts | Client ID and Client Secret | Send payouts and disburse funds using Cashfree Payouts. | | Cashfree Secure ID | Client ID and Client Secret | Verify user identity using Cashfree Secure ID. | | Cashfree Subscription | Client ID and Client Secret | Manage recurring payments using Cashfree Subscriptions. | | Google Sheets | OAuth2 | Create and manage spreadsheets; add rows, create spreadsheets, or create worksheets. | | Slack | OAuth2 | Send messages to channels or users via a Slack workspace. | | Gmail | OAuth2 | Send emails or request approvals through a Gmail account. | | WhatsApp Business | Access token | Send messages via a WhatsApp Business account. | | Google Gemini | API key | Use Google Gemini models for content generation and analysis. | | OpenAI | API key | Access ChatGPT models for a wide range of AI-powered actions. | | Calendly | API key (Personal Token) | Manage scheduling actions via a Calendly account. | | Bolna AI | API key | Use Bolna AI's voice calling platform for AI-powered customer calls. | | Osvi AI | API key | AI phone calling platform for outbound voice agents. | | Sarvam AI | API key | Use the tools offered by Sarvam. | | Anthropic Claude | API key | Use Anthropic Claude models for content generation and analysis. | ## Add a connection To add a connection, follow these steps. 1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login) and go to **Payment Gateway > Relay**. 2. Click the **Connections** tab. 3. Click **Add new connection**. The **Add connection** dialogue opens, listing all available integrations. 4. (Optional) Use the **Search integrations** field to filter the list by name. 5. Select the integration you want to connect. The **Configure connection** panel opens for the selected app. 6. In the **Connection name** field, enter a name to identify this connection. 7. Fill in the required fields for the selected integration. See [Configure a connection](#configure-a-connection) for integration-specific steps. 8. Click **Connect** or **Test** to authenticate, depending on the integration. 9. Click **Save** to add the connection. Add a connection The new connection appears in the list on the **Connections** tab and is available for use in agents. Each connection is specific to the account you authenticate with during setup. If you need to connect a different account for the same app, add a new connection for it. ## Delete a connection You can delete a connection that is no longer needed. Connections cannot be edited; to update a connection, delete it and create a new one. 1. Go to **Payment Gateway > Relay > Connections**. 2. In the **Actions** column for the connection, click the delete icon. A confirmation dialogue appears. 3. Click **Delete** to confirm, or **Cancel** to go back. Deleting a connection removes it permanently and cannot be undone. Any agent that uses this connection stops working. Review and update affected agents before deleting. ## Configure a connection The configuration steps and required credentials vary by integration. Select your integration below for the required fields and authentication steps. Human-in-the-Loop (HITL) approvals let you pause an agent so a person can approve or reject an action, such as a high-value refund, before it continues. Some integrations require additional setup beyond the standard connection steps to support HITL approvals. Currently, this applies to the Slack and WhatsApp Business integrations; the extra steps are included in their sections below. Google Sheets and Gmail both use OAuth2 and share the same Google Cloud credentials. You can use a single Client ID and Client Secret for both integrations by registering one OAuth2 application in the Google Cloud Console and enabling each Google API under the same project. To enable APIs, go to **APIs & Services > Library** in the [Google Cloud Console](https://console.cloud.google.com) and enable the APIs for the services you want to connect. This avoids creating separate credentials for each integration. **Authentication type**: Client ID and Client Secret Cashfree uses your App ID and Secret Key for authentication. Each Cashfree product requires its own set of credentials. If you are connecting multiple products such as Payments and Payouts, you must generate separate API keys for each. To get your App ID and Secret Key: 1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/merchants) and go to **Developers**. 2. Click **API Keys** under the product you want to connect, such as Payment Gateway. 3. Generate your API keys based on your environment: * **Test environment**: Cashfree auto-generates your API keys. No additional action is required. * **Production environment**: Click **Generate API Keys** and complete two-factor authentication (2FA) to generate the keys. 4. Once generated, the keys are shown in masked format. Click the ellipsis and select **View API Key** to reveal them. 5. Copy the **App ID** and **Secret Key** and store them securely. You can only generate one API key pair at a time. If your keys are lost, you must regenerate them from the dashboard. Never expose your Secret Key on the client side or commit it to source control. To configure the connection: 1. In the **Configure connection — Cashfree** panel, update the **Connection name** if needed. 2. Paste your App ID in the **Cashfree Client ID** field. 3. Paste your Secret Key in the **Cashfree Client Secret** field. 4. Click **Save**. For more information, refer to [Authentication](/docs/api-reference/authentication#generate-api-keys) topic in the API Reference. **Authentication type**: Client ID and Client Secret Cashfree Payouts uses your Client ID and Client Secret for authentication. These credentials are separate from your Cashfree credentials; generate them from the Payouts Dashboard even if you already have API keys for another Cashfree product. To get your Client ID and Client Secret: 1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/merchants) and go to **Payouts Dashboard > Developers**. 2. Click **API Keys**. 3. Click **Generate API Keys** and complete the required authentication to generate the keys. 4. Copy the **Client ID** and **Client Secret** and store them securely. To configure the connection: 1. In the **Configure connection — Cashfree Payouts** panel, update the **Connection name** if needed. 2. Paste your Client ID in the **Cashfree Client ID** field. 3. Paste your Client Secret in the **Cashfree Client Secret** field. 4. Click **Save**. For more information, refer to [Integrations](/docs/payouts/payouts/integrations/integrations) topic in the Payouts documentation. **Authentication type**: Client ID and Client Secret Cashfree Secure ID uses your Client ID and Client Secret for authentication, generated the same way as your other Cashfree product credentials. To get your Client ID and Client Secret: 1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/merchants) and go to **Developers**. 2. Click **API Keys** under **Secure ID**. 3. Generate your API keys based on your environment: auto-generated for the test environment, or click **Generate API Keys** and complete the 2FA authentication for the production environment. 4. Copy the **Client ID** and **Secret** and store them securely. To configure the connection: 1. In the **Configure connection — Cashfree Secure ID** panel, update the **Connection name** if needed. 2. Paste your Client ID in the **Cashfree Client ID** field. 3. Paste your Secret in the **Cashfree Client Secret** field. 4. Click **Save**. For more information, refer to [Authentication](/docs/api-reference/authentication#generate-api-keys) topic in the API Reference. **Authentication type**: Client ID and Client Secret Cashfree Subscription reuses your Payment Gateway credentials. If you already have a Cashfree connection, use the same Client ID and Client Secret; otherwise, follow the steps in the **Cashfree** section above to generate them. To configure the connection: 1. In the **Configure connection — Cashfree Subscription** panel, update the **Connection name** if needed. 2. Paste your Client ID in the **Cashfree Client ID** field. 3. Paste your Client Secret in the **Cashfree Client Secret** field. 4. Click **Save**. For more information, refer to [Authentication](/docs/api-reference/authentication#generate-api-keys) topic in the API Reference. **Authentication type**: OAuth2 Google Sheets uses OAuth2 to authenticate via your Google account. Before setting up this connection, you must enable both the **Google Sheets API** and the **Google Drive API**, and register an OAuth2 application in the Google Cloud Console to obtain a Client ID and Client Secret. Enabling both the Google Sheets API and the Google Drive API in your Google Cloud project is mandatory. Without these steps, the Google Sheets integration will not work even if your OAuth credentials are configured correctly. To enable the required APIs: 1. Go to the [Google Cloud Console](https://console.cloud.google.com) and select your project. 2. Go to **APIs & Services > Library**. 3. Search for **Google Sheets API** and **Google Drive API** and click **Enable**. To create OAuth2 credentials: 1. In the [Google Cloud Console](https://console.cloud.google.com/apis/credentials), go to **APIs & Services > Credentials**. 2. Click **Create Credentials** > **OAuth client ID**, select **Web application** as the application type, and paste the **Redirect URI** (copied from the Configure connection panel) under **Authorised redirect URIs**. 3. Copy the generated **Client ID** and **Client Secret**. To configure the connection: 1. In the **Configure connection — Google Sheets** panel, update the **Connection name** if needed. 2. Copy the **Redirect URI** by clicking **Copy**. 3. Complete the OAuth2 credential steps above, then enter the **Client ID** and **Client Secret** in the respective fields in the panel. 4. Click **Connect**. The Google authorisation page opens. 5. Log in and grant the requested permissions. 6. Click **Save**. If you have already created OAuth2 credentials for Gmail, you can reuse the same Client ID and Client Secret for this connection. See the note at the top of this section for details. For more information, refer to [Setting up OAuth 2.0: Google Cloud](https://support.google.com/googleapi/answer/6158849). **Authentication type**: OAuth2 Slack uses OAuth2 with a Slack app you register in the Slack API. Install the app to your workspace after configuring scopes so Relay can act on behalf of the bot. If you plan to use HITL approvals in your agents, you must also enable Slack's Interactivity feature, covered in the steps below. You need a Slack app to complete this connection. Create one using either of the methods below. Slack lets you create an app from an app manifest, a JSON file that configures the app name, OAuth scopes, redirect URL, and Interactivity request URL in a single step. The manifest below is pre-configured for use with Cashfree Relay, including HITL approvals. 1. Go to [api.slack.com/apps](https://api.slack.com/apps) and click **Create New App**. 2. Select **From an app manifest**. 3. Select your workspace and click **Next**. 4. Paste the manifest below in the **JSON** tab, click **Next**, then click **Create**. ```json theme={"dark"} { "display_information": { "name": "Approval App for Cashfree Payments" }, "features": { "bot_user": { "display_name": "Workflow Approval App for Cashfree Payments", "always_online": false } }, "oauth_config": { "redirect_urls": [ "https://merchant.cashfree.com/relay/oauth/callback" ], "scopes": { "bot": [ "channels:read", "chat:write", "chat:write.public", "im:read", "im:write", "incoming-webhook", "users:read" ] }, "pkce_enabled": false }, "settings": { "interactivity": { "is_enabled": true, "request_url": "https://push.cashfree.com/relay/hitl/v1/callback" }, "org_deploy_enabled": false, "socket_mode_enabled": false, "token_rotation_enabled": false, "is_mcp_enabled": false } } ``` 5. Go to **OAuth & Permissions**, then click **Install to Workspace** and grant the requested permissions. 6. From the **Basic Information** page, copy the **Client ID** and **Client Secret**. 7. In the **Configure connection — Slack** panel, update the **Connection name** if needed, then enter the **Client ID** and **Client Secret**. 8. Click **Connect**. The Slack authorisation page opens. 9. Log in and grant the requested permissions. 10. Click **Save**. Use this method if you prefer to configure each setting individually, or already have a Slack app. 1. Go to [api.slack.com/apps](https://api.slack.com/apps), click **Create New App**, select **From scratch**, enter an app name, and select your workspace. For more information, refer to [Creating an app from app settings: Slack Developer Docs](https://docs.slack.dev/app-management/quickstart-app-settings). 2. In the **Configure connection — Slack** panel, update the **Connection name** if needed. 3. Copy the **Redirect URI** by clicking **Copy**. 4. In your [Slack app settings](https://api.slack.com/apps), go to **OAuth & Permissions** and paste the copied Redirect URI under **Redirect URLs**. 5. On the same **OAuth & Permissions** page, under **Scopes**, add each of the following permissions using **Add an OAuth Scope**. | Scope | Description | Required | | ------------------- | ------------------------------------------------ | -------- | | `channels:read` | View basic information about public channels | Yes | | `chat:write` | Send messages to channels | Yes | | `chat:write.public` | Send messages to public channels without joining | Yes | | `im:read` | View basic information about direct messages | Yes | | `im:write` | Start direct messages with people | Yes | | `incoming-webhook` | Post messages to a specific channel | Yes | | `users:read` | View people in the workspace | Yes | 6. If you plan to use HITL approvals in your agents, go to **Interactivity & Shortcuts**, turn on **Interactivity**, and enter the following in **Request URL**: `https://push.cashfree.com/relay/hitl/v1/callback`. Click **Save Changes**. 7. From the **Basic Information** page of your Slack app, copy the **Client ID** and **Client Secret** and enter them in the respective fields in the panel. 8. Click **Connect**. The Slack authorisation page opens. 9. Log in and grant the requested permissions. Install the app to your workspace if Slack prompts you to. 10. Click **Save**. If you change scopes after installing the app, reinstall it to your workspace so the updated permissions take effect. For more information, refer to [Installing with OAuth: Slack Developer Docs](https://docs.slack.dev/authentication/installing-with-oauth/). **Authentication type**: OAuth2 Gmail uses OAuth2 to authenticate via your Google account. Before setting up this connection, register an OAuth2 application in the Google Cloud Console to obtain a Client ID and Client Secret. 1. In the **Configure connection — Gmail** panel, update the **Connection name** if needed. 2. Copy the **Redirect URI** by clicking **Copy**. 3. In the [Google Cloud Console](https://console.cloud.google.com/apis/credentials), go to **APIs & Services > Credentials**. 4. Click **Create Credentials** > **OAuth client ID**, select **Web application** as the application type, and paste the copied Redirect URI under **Authorised redirect URIs**. 5. Copy the generated **Client ID** and **Client Secret** from the Google Cloud Console and enter them in the respective fields in the panel. 6. Click **Connect**. The Google authorisation page opens. 7. Log in and grant the requested permissions. 8. Click **Save**. If you have already created OAuth2 credentials for Google Sheets, you can reuse the same Client ID and Client Secret for this connection. See the note at the top of this section for details. For more information, refer to [Setting up OAuth 2.0: Google Cloud](https://support.google.com/googleapi/answer/6158849). **Authentication type**: System user access token WhatsApp Business uses a system user access token and a WhatsApp Business Account ID (WABA ID) for authentication. These are generated from Meta Business Suite and are long-lived, making them suitable for automated integrations. If you plan to use HITL approvals in your agents, you must also configure a webhook for your app on [Meta for Developers](https://developers.facebook.com/apps), covered later in this section. The **Business Account ID** field in the Configure connection panel refers to your **WhatsApp Business Account ID (WABA ID)**, found on [Meta for Developers](https://developers.facebook.com/apps) under **WhatsApp > API Setup**. This is not the same as your Meta Business Portfolio ID, found in Meta Business Suite settings. Using the Business Portfolio ID instead of the WABA ID will not work. To get your system user access token and business account ID: 1. Go to [Meta for Developers](https://developers.facebook.com/apps) and open your app, or create one if you don't have one. Choose an **App**, not a **Test App** created via the **Create Test App** menu. 2. If the **WhatsApp** product is not already added to your app, add it. 3. On the app's main page, select the **Connect with customers through WhatsApp** use case and click **Customize**. 4. Log in to [Meta Business Suite](https://business.facebook.com). 5. Click the **Settings** (gear) icon for your business portfolio. 6. Go to **Users > System Users**. 7. Click **Add** and create a system user with the **Admin** role. 8. Click **Assign Assets**, select both your WhatsApp app and your WhatsApp Business Account, enable **Full control** for each, and click **Assign assets**. 9. Click **Generate Token**, select your app, enable the `whatsapp_business_messaging` and `whatsapp_business_management` permissions, and click **Generate Token**. 10. Copy and store the token securely. It is displayed only once. 11. Copy your **WhatsApp Business Account ID** from [Meta for Developers](https://developers.facebook.com/apps) under **WhatsApp > API Setup**. For more information, refer to [System User access tokens: Meta for Developers](https://developers.facebook.com/documentation/business-messaging/whatsapp/access-tokens/). To configure the connection: 1. In the **Configure connection — WhatsApp Business** panel, update the **Connection name** if needed. 2. Paste your system user access token in the **System User Access Token** field. 3. Paste your business account ID in the **Business Account ID** field. 4. Click **Save**. To use HITL approvals with WhatsApp Business, configure a webhook for your app on [Meta for Developers](https://developers.facebook.com/apps) so Cashfree can receive approval responses. 1. In [Meta for Developers](https://developers.facebook.com/apps), open your app, go to the **WhatsApp** product, then **Configuration**. 2. Under **Webhooks**, click **Configure webhooks** (or **Edit** if already configured). 3. In **Callback URL**, enter the URL for your environment from the following table: | Environment | Callback URL | | ------------------- | ------------------------------------------------------------------------------------------------- | | Local (development) | Use a tunnelling tool, such as [ngrok](https://ngrok.io) or [webhook.site](https://webhook.site). | | Production | `https://push.cashfree.com/relay/hitl/v1/webhook/whatsapp` | 4. In **Verify Token**, enter a secret string of your choice. Meta echoes this value back to confirm the request is genuinely from Meta. 5. Click **Verify and Save**. 6. Under **Webhook fields**, find **messages** and click **Test**. In the dialogue that opens, click **Send to server** to verify Cashfree receives the test payload, then toggle the field from **Unsubscribed** to **Subscribed**. Cashfree's WhatsApp Business integration requires **Meta Graph API v25.0 or later**. Meta periodically deprecates older API versions; agents configured on a deprecated version stop working. Check your app's API version on Meta for Developers and update it if needed. For more information, refer to [Webhooks: WhatsApp Business Platform, Meta for Developers](https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/overview). **Authentication type**: API key Google Gemini uses an API key for authentication. API keys are created and managed in Google AI Studio. The Google Gemini integration uses an API that is currently in beta and may change at any time. To get your Google Gemini API key: 1. Go to [Google AI Studio](https://aistudio.google.com/apikey) and log in with your Google account. 2. Click **Create API key**. 3. Select an existing Google Cloud project or create a new one. 4. Copy the generated API key and store it securely. To configure the connection: 1. In the **Configure connection — Google Gemini** panel, update the **Connection name** if needed. 2. Paste your API key in the **Enter API key** field. 3. Click **Test** to verify the connection. 4. Click **Save**. For more information, refer to [Gemini API keys: Google AI for Developers](https://ai.google.dev/gemini-api/docs/api-key). **Authentication type**: API key OpenAI uses an API key for authentication. API keys are created and managed from the OpenAI platform dashboard. Add your billing information and upgrade to a paid OpenAI plan **before** generating an API key. This helps prevent `429` rate limit errors when the integration is in use. To get your OpenAI API key: 1. Go to [platform.openai.com/api-keys](https://platform.openai.com/api-keys) and log in. 2. Click **Create new secret key**. 3. Give the key a name and click **Create secret key**. 4. Copy the key and store it securely. It is displayed only once. To configure the connection: 1. In the **Configure connection — OpenAI** panel, update the **Connection name** if needed. 2. Paste your API key in the **Enter API key** field. 3. Click **Test** to verify the connection. 4. Click **Save**. For more information, refer to [API keys: OpenAI Platform](https://platform.openai.com/api-keys). **Authentication type**: API key (Personal Token) Calendly uses a personal access token for authentication. Follow the steps below to obtain your token from the Calendly app. To get your Calendly personal access token: 1. Log in to your [Calendly account](https://calendly.com). 2. Go to **Integrations > API & Webhooks**. 3. Under **Personal Access Tokens**, click **Get a token now** if you have no prior tokens, or **Generate new token** if you already have one. 4. Enter a name for the token and click **Create Token**. 5. Copy the token. Calendly does not display your personal access token again after generation. Copy and store it securely before closing the dialogue. To configure the connection: 1. In the **Configure connection — Calendly** panel, update the **Connection name** if needed. 2. Paste your personal token in the **Enter API key** field. 3. Click **Test** to verify the connection. 4. Click **Save**. For more information, refer to [Personal access tokens: Calendly Developer Docs](https://developer.calendly.com/personal-access-tokens). **Authentication type**: API key Bolna AI uses an API key for authentication, generated from the Bolna AI dashboard. To get your Bolna AI API key: 1. Log in to the dashboard at [platform.bolna.ai](https://platform.bolna.ai). 2. Go to the **Developers** tab from the left menu bar. 3. Click **Generate a new API Key**. 4. Copy the generated key and store it securely. It is shown only once. To configure the connection: 1. In the **Configure connection — Bolna AI** panel, update the **Connection name** if needed. 2. Paste your key in the **Bolna AI API Key** field. 3. Click **Save**. For more information, refer to [Authentication](https://www.bolna.ai/docs/api-reference/authentication) in the Bolna AI documentation. **Authentication type**: API token Osvi AI uses an API token for authentication, generated from your Osvi account settings. To get your API token: 1. Log in to your Osvi account. 2. Go to **Settings > API**. 3. Copy the 16-character **API-Token**. To configure the connection: 1. In the **Configure connection — Osvi AI** panel, update the **Connection name** if needed. 2. Paste your token in the **API-Token** field. 3. Click **Save**. For more information, refer to [API Reference: Introduction](https://docs.osvi.ai/api-reference/introduction) in the Osvi AI documentation. **Authentication type**: API key Sarvam AI uses an API subscription key for authentication, created from the Sarvam Dashboard. To get your API subscription key: 1. Log in to the [Sarvam Dashboard](https://dashboard.sarvam.ai). 2. Go to **API Keys**. 3. Create and copy your API subscription key. To configure the connection: 1. In the **Configure connection — Sarvam AI** panel, update the **Connection name** if needed. 2. Paste your key in the **API Subscription Key** field. 3. Click **Save**. For more information, refer to the [Sarvam Dashboard](https://dashboard.sarvam.ai). **Authentication type**: API key Anthropic Claude uses an API key for authentication, generated from the Claude Platform Console. To get your Claude API key: 1. Sign in at [platform.claude.com](https://platform.claude.com), creating an account if you don't have one. 2. Go to **Settings > API keys**. 3. Click **Create key**, name the key, and optionally choose a workspace and expiration. 4. Copy the generated key and store it securely. The key starts with `sk-ant-` and is shown only once; if you lose it, create a new one. If **Create key** is disabled, you do not have permission to create keys in that workspace. Ask a workspace admin to grant access or create the key for you. To configure the connection: 1. In the **Configure connection — Anthropic Claude** panel, update the **Connection name** if needed. 2. Paste your key in the **API Key** field. 3. Click **Save**. For more information, refer to [Get your Claude API key](https://platform.claude.com/docs/en/get-api-key) in the Claude Platform documentation.