Documentation

Integration Setup Guide

The following guide provides detailed instructions for connecting every integration mentioned above. Follow these steps carefully and store all API keys and tokens securely. For additional context and citations, please refer to the original sources in the footnotes.

Ramen AI – Integration Setup Guide

This guide collects step‑by‑step instructions for connecting all supported services to Ramen AI. Each integration section explains how to obtain credentials (API keys or OAuth tokens) and provides the official link to the provider’s settings page. Follow these steps carefully and treat any keys or tokens like passwords – copy them once and store them securely. Never share them publicly.

Email Providers

Resend

Resend is a transactional email service recommended for high deliverability. You integrate it by generating an API key.

1. Log in to Resend and open the API Keys page at https://app.resend.com/api-keys.
2. Click Create API Key. Provide a name or description for the key. Select the necessary permissions (for example, “Full Access” or “Sending Access”). Optionally restrict the key to a domain.
3. Click Add to generate the key. Resend will display the key once – copy it immediately and store it securely. Use this key in the Ramen AI settings under Email Providers → Resend. If you lose the key, generate a new one.

Gmail / Google Workspace

Ramen AI connects to Gmail or Google Workspace via OAuth 2.0. This requires a Google Cloud project and Gmail API credentials.

1. Go to the Google Cloud Console and create a new project or select an existing one.
2. In the APIs & Services dashboard, click Enable APIs and Services and enable the Gmail API.
3. Navigate to OAuth consent screen. Choose “Internal” (for Workspace users) or “External.” Provide the app name and domain; add authorized scopes (e.g., Gmail send and read scopes); and add test users.
4. Under Credentials, click Create Credentials → OAuth Client ID. Select “Web application,” specify a name, and add the Authorized redirect URI provided by Ramen AI (e.g., https://app.ramen.ai/auth/google) .
5. After creating the OAuth client, copy the Client ID and Client Secret. Enter these values in Ramen AI under Email Accounts → Google Workspace. When prompted, click Authorize and sign in with the Gmail or Workspace account whose inbox you want to send from. Approve the requested permissions and complete the integration.

Outlook / Microsoft 365

Ramen AI integrates with Outlook via Azure’s OAuth. You must register an app in the Azure Portal.

1. Visit the Azure Portal and navigate to Azure Active Directory → App registrations.
2. Click New registration. Enter an app name, select supported account types, and add the Redirect URI provided by Ramen AI (type: “Web”). Save the registration.
3. On the app’s Overview page, note the Application (client) ID. Go to Certificates & secrets and click New client secret. Provide a description and expiry; copy the secret value once generated.
4. Under API Permissions, click Add a permission → Microsoft Graph. Add the following delegated scopes: Mail.Read, Mail.Send, offline_access, openid, profile, and email.
5. Navigate to Authentication. Ensure the redirect URI matches Ramen AI’s callback URL and enable “Allow public client flows (mobile & desktop)” if applicable.
6. In Ramen AI, open Email Accounts → Outlook, enter the Client ID and Client Secret, and then authorize the connection. Sign in with the desired Microsoft 365 account and grant the requested permissions.

CRMs & Sales Platforms

Salesforce

To sync leads with Salesforce, create a Connected App and use its OAuth credentials.

1. Log into Salesforce, click the gear icon, and select Setup → App Manager. Click New Connected App.
2. Provide a Connected App Name, API Name, and a contact email. Under API (Enable OAuth Settings), check Enable OAuth Settings.
3. Enter the callback URL given by Ramen AI (e.g., https://app.ramen.ai/auth/salesforce). Add required OAuth scopes such as Full access (full), Perform requests on your behalf at any time (refresh_token, offline_access), and others relevant to your use case.
4. Save the app and wait for Salesforce to process it. Then return to App Manager, locate your connected app, and click View. Copy the Consumer Key and Consumer Secret.
5. In Ramen AI, navigate to CRM Sync → Salesforce. Enter the Consumer Key and Consumer Secret, then authorize the connection. When prompted, sign in to Salesforce and approve access.

HubSpot

HubSpot integrations require a private app token (API keys are deprecated). A Super Admin must create the app.

1. Log into your HubSpot account and go to Settings → Integrations → Private Apps.
2. Click Create private app. Under Basic Info, give the app a name and optional logo.
3. In the Scopes tab, add the scopes you need (e.g., crm.objects.contacts.read, crm.objects.deals.write). Click Create app and confirm.
4. After the app is created, open its Auth tab and click Show token. Copy the Access Token and store it securely; it’s displayed only once.
5. In Ramen AI, go to CRM Sync → HubSpot, paste the access token, and save. Ramen AI will use this token to read/write data in your HubSpot account.

Pipedrive

Each Pipedrive user has a unique API token. Use it to connect Ramen AI.

1. Log in to Pipedrive. Click your account name in the top right, choose Company settings, then Personal preferences → API.
2. Copy the API token shown. Keep it secret – anyone with the token can access your Pipedrive data.
3. In Ramen AI, go to CRM Sync → Pipedrive and paste the token. Save to complete the integration.

Zoho CRM

Zoho uses OAuth 2.0. You must register an OAuth client and exchange an authorization code for tokens.

1. Open the Zoho API Console and create a server‑based client. Provide a client name, homepage URL, and Authorized redirect URI (Ramen AI’s callback). After saving, note the Client ID and Client Secret.
2. Build an authorization URL using your Zoho accounts domain (e.g., https://accounts.zoho.com/oauth/v2/auth) and include parameters: scope, client_id, response_type=code, and redirect_uri. Open this URL in a browser and grant access.
3. After authorization, Zoho redirects to your redirect URI with a code parameter. Exchange this code for tokens by sending a POST request to https://accounts.zoho.com/oauth/v2/token with parameters: grant_type=authorization_code, code, client_id, client_secret, and redirect_uri. Zoho returns an access token and refresh token.
4. Use the access token in the Authorization: Zoho-oauthtoken {access_token} header for API calls and configure Ramen AI to use it. When the token expires, refresh it by sending another POST request with grant_type=refresh_token and your refresh token.

Meeting Platforms

Calendly

Calendly offers two authentication options: personal access tokens (PAT) or OAuth. PAT is easiest for individual accounts.

1. Log into Calendly and go to Integrations → API & Webhooks (https://calendly.com/integrations/api-webhooks) .
2. If you have no token, click Get a token now; otherwise, click Generate new token.
3. Provide a descriptive name and click Create Token. Calendly displays the token once – copy and store it securely.
4. Enter this token in Ramen AI under Meeting Platforms → Calendly. The token is used in the Authorization: Bearer YOUR_TOKEN header for API calls.

Cal.com

Cal.com uses API keys. You must generate one in your account.

1. Log into Cal.com and navigate to Settings → API Keys (https://app.cal.com/settings/api).
2. Click + New API key. Provide a name (and optional description) and click Save.
3. The key is generated and shown only once. Copy it and store securely.
4. Use this key in Ramen AI as a query parameter (?apiKey=cal_live_xxxx) when making Cal.com API requests and ensure all requests are sent over HTTPS.

Google Meet

Google Meet links can be generated via the Google Calendar API. This integration requires admin privileges and service account setup.

1. In Google Cloud Console, enable the Google Calendar API for your project.
2. Create a service account with Domain‑wide delegation and generate a JSON key file.
3. In your Google Workspace Admin console, delegate domain‑wide authority to the service account for the required scopes (e.g., calendar.events).
4. Create or designate a Gmail user that will own the meeting events.
5. In Ramen AI, go to Meeting Platforms → Google Meet. Upload the JSON key, specify the delegated user’s email and calendar ID, and save. Ramen AI will use this service account to create Google Meet meetings.

Zoom

Ramen AI integrates with Zoom via OAuth. You must create an app in the Zoom App Marketplace.

1. Sign into the Zoom App Marketplace and click Develop → Build App.
2. Select OAuth and choose Admin‑managed. Provide an app name and click Create.
3. In the app’s App Credentials section, note the Client ID and Client Secret. Under Redirect URL for OAuth, enter the callback URL from Ramen AI (e.g., https://app.ramen.ai/auth/zoom) and add it to the allow list.
4. Skip the features section. Under Scopes, add required scopes (such as meeting:read, meeting:write, user:read:admin). Click Activate or Manage to finalize the app.
5. In Ramen AI, navigate to Meeting Platforms → Zoom. Enter the Client ID and Client Secret, then click Authorize. Sign into your Zoom admin account and grant permissions to complete the integration.

AI Models

OpenAI

OpenAI provides the GPT family of models. You need a secret key to call the API.

1. Sign in at platform.openai.com. Click your profile icon and choose View API keys.
2. On the API Keys page, click Create new secret key. Provide a name and click Create.
3. Copy the generated key – it’s visible only once. Paste this key into Ramen AI under AI Models → OpenAI.

Google Gemini

Gemini (formerly Google Bard) is available via Google AI Studio.

1. Visit Google AI Studio and sign in with your Google account.
2. Open the API Keys section. If prompted, create a new project or select an existing one. Click Create API Key, choose the project and confirm.
3. Copy the generated API key and store it securely. Use this key in Ramen AI under AI Models → Gemini.

Anthropic Claude

Anthropic’s Claude models require an API key and billing setup.

1. Go to console.anthropic.com and sign up or sign in.
2. Click your profile and select API Keys. Click Create Key, give it a name, and copy the key – it’s shown only once.
3. Ensure you have a billing plan (Anthropic offers free credits or a paid subscription). Enter this key in Ramen AI under AI Models → Claude.

DeepSeek

DeepSeek offers deepseek-chat and deepseek-reasoner models via API.

1. Sign up at https://platform.deepseek.com/ and visit the API keys page (/api_keys). Click Create API Key.
2. Provide a name, then copy the key once displayed. Use the key with the Authorization: Bearer YOUR_API_KEY header when calling DeepSeek endpoints such as https://api.deepseek.com/chat or https://api.deepseek.com/reasoner .
3. Enter the key in Ramen AI under AI Models → DeepSeek.

Grok (xAI)

xAI’s Grok model requires an API key.

1. Create an account at console.x.ai and log in.
2. Navigate to API Keys. Click Create key, provide a name, and copy the key. Export it as an environment variable if desired.
3. Enter this key in Ramen AI under AI Models → Grok. Use it with the xAI API endpoints.

Lead Enrichment

Hunter.io

Hunter provides domain search and email verification. Access to the API requires a secret key.

1. Log into your Hunter account and open the API page (https://dashboard.hunter.io/api).
2. If you have no key, click Generate new key. Copy the API secret key – you can manage and delete keys from this page.
3. In Ramen AI, go to Lead Enrichment → Hunter.io, enter your API key, and save. Use the key in the api_keyquery parameter when calling Hunter’s API.

Snov.io

Snov.io requires OAuth credentials to obtain a temporary access token.

1. Sign in to Snov.io and go to Settings → API. Copy your User ID and API Secret.
2. Request an access token by sending a POST request to https://api.snov.io/v1/oauth/access_token with grant_type=client_credentials, client_id (your User ID) and client_secret (API Secret). Snov.io returns an access_token valid for one hour.
3. Use this token in the Authorization: Bearer YOUR_ACCESS_TOKEN header for Snov.io API calls. Enter the User ID and Secret in Ramen AI so it can automatically obtain and refresh tokens.

Seamless.ai

Seamless.ai offers contact and company data via API.

1. Log into your Seamless.ai account. In Settings → API Key, click Create New Connection.
2. Provide a name if prompted. Copy the generated API key – Seamless allows up to 25 keys and you can revoke keys at any time.
3. Use this key in the Token header when calling Seamless.ai endpoints. Enter the key in Ramen AI under Lead Enrichment → Seamless.ai.

Apollo

Apollo’s API provides access to prospect data. You need to generate a token from your Apollo dashboard.

1. Log into Apollo and navigate to Settings → Integrations → API Keys.
2. Click Create new key, name your key, and select the endpoints it should access. For full access, create a Master key.
3. Copy the API key and store it securely. Use this key in the Authorization header when calling Apollo’s API and enter it in Ramen AI under Lead Enrichment → Apollo.

ZoomInfo

ZoomInfo provides company and contact intelligence via API. You must generate a token from the ZoomInfo Admin Portal.

1. Sign in to ZoomInfo. Click the grid icon and choose Admin Portal.
2. In the left navigation, select Integrations and then API. Click Generate new API key.
3. Copy the Client ID and Private Key (or token) provided – these credentials allow API access. Enter them into Ramen AI under Lead Enrichment → ZoomInfo.

Notification Channels

Slack

Post notifications to Slack by creating an app with an incoming webhook.

1. Go to api.slack.com/apps and click Create New App. Choose “From scratch,” give the app a name, and select your workspace.
2. In the app’s settings sidebar, enable Incoming Webhooks and toggle it on.
3. Click Add New Webhook to Workspace, select a channel where Ramen AI will post messages, and click Allow.
4. Slack provides a Webhook URL. Copy this URL and keep it confidential – anyone with the URL can post messages. Enter it in Ramen AI under Notification Channels → Slack.

Discord

Discord notifications require a bot token.

1. Visit the Discord Developer Portal and click New Application. Provide an application name and create the app.
2. In the app settings, go to the Bot tab and click Add Bot. Confirm and reveal the bot’s token. Copy the token and keep it secret.
3. Ensure the bot has the necessary intents (such as SERVER MEMBERS INTENT) depending on your use case. Note: you must invite the bot to your server using an OAuth URL with appropriate scopes (bot and webhook.incoming).
4. Enter the bot token in Ramen AI under Notification Channels → Discord.

Telegram

Telegram bots are managed by @BotFather.

1. Open Telegram and start a chat with @BotFather. Send the command /newbot and follow the prompts to choose a name and username for your bot.
2. BotFather will return a bot token (a long string). Copy this token and treat it as a password.
3. Enter the token in Ramen AI under Notification Channels → Telegram. Use the sendMessage API with the bot token to post notifications to your chat or channel.

WhatsApp Business API

WhatsApp notifications use the Meta Business API. You need a permanent access token.

1. In Facebook Business Manager, go to Business Settings → Users → System Users. Click Add to create a new system user and assign a role (e.g., Admin).
2. Select the system user and choose Generate new token. Choose your Meta app and select the permissions whatsapp_business_management and whatsapp_business_messaging.
3. Copy the generated permanent access token – it does not expire unless revoked. Assign the WhatsApp Business account asset to the system user and grant full control.
4. Enter this token in Ramen AI under Notification Channels → WhatsApp. Use the token with the Graph API (https://graph.facebook.com/v18.0/YOUR_PHONE_NUMBER_ID/messages) to send messages.

Tips & Best Practices

• Treat keys like passwords. API keys, client secrets and tokens grant access to your data. Never hard‑code them in client-side code or share them publicly.
• Use least‑privilege scopes. When configuring OAuth scopes or API permissions, only select the scopes required for your use case.
• Rotate keys periodically. Many providers allow you to generate multiple keys – rotate them regularly and delete old keys.
• Secure storage. Store sensitive credentials in a secrets manager or environment variable. Avoid storing them in plain text.
• Check quotas and limits. Each provider has rate limits; consult their documentation to avoid throttling or extra charges.

By following the steps above, you can connect every integration supported by Ramen AI and ensure a smooth experience for your sales and marketing automation.