Set Up Relay Connections | Cashfree Payments

Connections link external apps and services to the Cashfree Merchant Dashboard, enabling workflows 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 a workflow. All connections are managed from the Connections tab on the Relay dashboard and can be reused across multiple workflows.

Supported integrations

The following integrations are available for use in workflows.

Integration	Authentication type	Description
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.
Calendly	API key (Personal Token)	Manage scheduling actions via a Calendly 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.
Cashfree Payments	Client ID and Client Secret	Process payments using Cashfree Payments.

Add a connection

To add a connection, follow these steps.

Log in to the Merchant Dashboard and go to Payment Gateway > Relay.
Click the Connections tab.
Click Add new connection. The Add connection dialogue opens, listing all available integrations.
(Optional) Use the Search integrations field to filter the list by name.
Select the integration you want to connect. The Configure connection panel opens for the selected app.
In the Connection name field, enter a name to identify this connection.
Fill in the required fields for the selected integration. See Configure a connection for integration-specific steps.
Click Connect or Test to authenticate, depending on the integration.
Click Save to add the connection.

The new connection appears in the list on the Connections tab and is available for use in workflows.

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.

Go to Payment Gateway > Relay > Connections.
In the Actions column for the connection, click the delete icon. A confirmation dialogue appears.
Click Delete to confirm, or Cancel to go back.

Deleting a connection removes it permanently and cannot be undone. Any workflow that uses this connection will stop working. Review and update affected workflows 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 a workflow 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 and enable the APIs for the services you want to connect. This avoids creating separate credentials for each integration.

Google Sheets

Authentication type: OAuth2Google 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:

Go to the Google Cloud Console and select your project.
Go to APIs & Services > Library.
Search for Google Sheets API and Google Drive API and click Enable.

To create OAuth2 credentials:

In the Google Cloud Console, go to APIs & Services > Credentials.
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.
Copy the generated Client ID and Client Secret.

To configure the connection:

In the Configure connection — Google Sheets panel, update the Connection name if needed.
Copy the Redirect URI by clicking Copy.
Complete the OAuth2 credential steps above, then enter the Client ID and Client Secret in the respective fields in the panel.
Click Connect. The Google authorisation page opens.
Sign in and grant the requested permissions.
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.

Slack

Authentication type: OAuth2Slack 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 workflows, 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.

Quick setup (manifest)
Manual setup

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.

Go to api.slack.com/apps and click Create New App.
Select From an app manifest.
Select your workspace and click Next.
Paste the manifest below in the JSON tab, click Next, then click Create.

{
    "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
    }
}

Go to OAuth & Permissions, then click Install to Workspace and grant the requested permissions.
From the Basic Information page, copy the Client ID and Client Secret.
In the Configure connection — Slack panel, update the Connection name if needed, then enter the Client ID and Client Secret.
Click Connect. The Slack authorisation page opens.
Log in and grant the requested permissions.
Click Save.

Use this method if you prefer to configure each setting individually, or already have a Slack app.

Go to 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.
In the Configure connection — Slack panel, update the Connection name if needed.
Copy the Redirect URI by clicking Copy.
In your Slack app settings, go to OAuth & Permissions and paste the copied Redirect URI under Redirect URLs.
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

If you plan to use HITL approvals in your workflows, 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.
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.
Click Connect. The Slack authorisation page opens.
Log in and grant the requested permissions. Install the app to your workspace if Slack prompts you to.
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.

Gmail

Authentication type: OAuth2Gmail 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.

In the Configure connection — Gmail panel, update the Connection name if needed.
Copy the Redirect URI by clicking Copy.
In the Google Cloud Console, go to APIs & Services > Credentials.
Click Create Credentials > OAuth client ID, select Web application as the application type, and paste the copied Redirect URI under Authorised redirect URIs.
Copy the generated Client ID and Client Secret from the Google Cloud Console and enter them in the respective fields in the panel.
Click Connect. The Google authorisation page opens.
Sign in and grant the requested permissions.
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.

Calendly

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:

Log in to your Calendly account.
Go to Integrations > API & Webhooks.
Under Personal Access Tokens, click Get a token now if you have no prior tokens, or Generate new token if you already have one.
Enter a name for the token and click Create Token.
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:

In the Configure connection — Calendly panel, update the Connection name if needed.
Paste your personal token in the Enter API key field.
Click Test to verify the connection.
Click Save.

For more information, refer to Personal access tokens – Calendly Developer Docs.

WhatsApp Business

Authentication type: System user access tokenWhatsApp 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 workflows, you must also configure a webhook for your app on Meta for Developers, covered later in this section.

The Business Account ID field in the Configure connection panel means your WhatsApp Business Account ID (WABA ID), found on Meta for Developers 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.

Get your System User Access Token and WABA ID

To get your system user access token and business account ID:

Go to Meta for Developers 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.
If the WhatsApp product is not already added to your app, add it.
On the app’s main page, select the Connect with customers through WhatsApp use case and click Customize.
Log in to Meta Business Suite.
Click the Settings (gear) icon for your business portfolio.
Go to Users > System Users.
Click Add and create a system user with the Admin role.
Click Assign Assets, select both your WhatsApp app and your WhatsApp Business Account, enable Full control for each, and click Assign assets.
Click Generate Token, select your app, enable the whatsapp_business_messaging and whatsapp_business_management permissions, and click Generate Token.
Copy and store the token securely. It is displayed only once.
Copy your WhatsApp Business Account ID from Meta for Developers under WhatsApp > API Setup.

For more information, refer to System User access tokens – Meta for Developers.

To configure the connection:

In the Configure connection — WhatsApp Business panel, update the Connection name if needed.
Paste your system user access token in the System User Access Token field.
Paste your business account ID in the Business Account ID field.
Click Save.

Configure a webhook for HITL approvals

To use HITL approvals with WhatsApp Business, configure a webhook for your app on Meta for Developers so Cashfree can receive approval responses.

In Meta for Developers, open your app, go to the WhatsApp product, then Configuration.
Under Webhooks, click Configure webhooks (or Edit if already configured).
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 or webhook.site.
Production	`https://push.cashfree.com/relay/hitl/v1/webhook/whatsapp`

In Verify Token, enter a secret string of your choice. Meta echoes this value back to confirm the request is genuinely from Meta.
Click Verify and Save.
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; workflows configured on a deprecated version will 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.

Google Gemini

Authentication type: API keyGoogle 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:

Go to Google AI Studio and sign in with your Google account.
Click Create API key.
Select an existing Google Cloud project or create a new one.
Copy the generated API key and store it securely.

To configure the connection:

In the Configure connection — Google Gemini panel, update the Connection name if needed.
Paste your API key in the Enter API key field.
Click Test to verify the connection.
Click Save.

For more information, refer to Gemini API keys – Google AI for Developers.

OpenAI

Authentication type: API keyOpenAI uses an API key for authentication. API keys are created and managed from the OpenAI platform dashboard.

It is strongly recommended that you 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:

Go to platform.openai.com/api-keys and sign in.
Click Create new secret key.
Give the key a name and click Create secret key.
Copy the key and store it securely. It is displayed only once.

To configure the connection:

In the Configure connection — OpenAI panel, update the Connection name if needed.
Paste your API key in the Enter API key field.
Click Test to verify the connection.
Click Save.

For more information, refer to API keys – OpenAI Platform.

Cashfree Payments

Authentication type: Client ID and Client SecretCashfree Payments 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:

Log in to the Merchant Dashboard and go to Developers.
Click API Keys under the product you want to connect, such as Payment Gateway.
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 the 2FA authentication to generate the keys.
Once generated, the keys are shown in masked format. Click the ellipsis and select View API Key to reveal them.
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:

In the Configure connection — Cashfree Payments panel, update the Connection name if needed.
Paste your App ID in the Cashfree Client ID field.
Paste your Secret Key in the Cashfree Client Secret field.
Click Save.

For more information, refer to Authentication topic in the API Reference.

Cashfree AI Stack

Cashfree Trust and Safety

Setting Up Connections

Supported integrations

Add a connection

Delete a connection

Configure a connection

​Supported integrations

​Add a connection

​Delete a connection

​Configure a connection

Supported integrations

Add a connection

Delete a connection

Configure a connection