> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beam.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Integration Connectors

> Connect agents to external services with pre-built integration connectors for CRM, communication, productivity, and automation

Integration connectors enable your agents to interact with external platforms like Salesforce, Gmail, Airtable, and Slack. Configure parameters using variable fill methods to pass data between your agent and these services.

Learn how to add integrations to your workflows in [Selecting Tools](/02-building-agents/agent-fundamentals/tools-integrations/tools-integrations).

## Configuring Parameters

Each integration action expects specific input parameters. Every integration provides parameter description guidelines that explain the required format.

<Frame>
  <img src="https://mintcdn.com/beamai/19PRqq2Lu11IakoJ/02-building-agents/agent-configuration/integrations/Screenshot%202025-11-07%20at%2023.12.33.png?fit=max&auto=format&n=19PRqq2Lu11IakoJ&q=85&s=441ee6bccaaf63f068097038d4e1bf36" alt="Integration parameter configuration" width="1290" height="588" data-path="02-building-agents/agent-configuration/integrations/Screenshot 2025-11-07 at 23.12.33.png" />
</Frame>

### Understanding Parameter Descriptions

Integration tools display parameter requirements with format guidelines directly in the configuration UI.

**Parameter Information:**

* **Name**: Field identifier (e.g., `site_name`, `search`, `folder_path`)
* **Description**: Format requirements and examples provided by the integration
* **Required/Optional**: Whether the parameter must be provided
* **Fill Method**: How the value will be populated

<Frame>
  <img src="https://mintcdn.com/beamai/19PRqq2Lu11IakoJ/02-building-agents/agent-configuration/integrations/Screenshot%202025-11-07%20at%2023.13.21.png?fit=max&auto=format&n=19PRqq2Lu11IakoJ&q=85&s=6dfc4c6fd90a620f728966d5555608df" alt="Parameter description guidelines" width="2250" height="1440" data-path="02-building-agents/agent-configuration/integrations/Screenshot 2025-11-07 at 23.13.21.png" />
</Frame>

### Fill Method Selection

Choose the fill method based on your data source:

**Linked Variables** - Pass data from previous nodes:

```
${previous_node.output_field}
```

**AI Fill** - AI constructs value from available context using the parameter description

**Static** - Fixed values that never change

**User Fill** - Runtime input from user

**From Memory** - Retrieved from agent's memory

### AI Fill Configuration

When using AI Fill, the parameter description provided by the integration guides the AI on how to format the output.

**Example: Google Sheets Append Row**

The integration provides this description for the `data` parameter:

```
Array of comma-separated value strings for each new row,
e.g. ["Alice","Bob","100", "Carol","Dave","200"]
```

**Your AI Fill Configuration:**

```
Extract customer name, email, and order total from the conversation.
Format as array of strings following the example format.
```

The AI combines the integration's format requirement with your extraction instructions.

**Example: Salesforce Update Record**

The integration provides this description for the `fields` parameter:

```
Key-value pairs of fields to update, e.g.
{"Name":"New Name","Phone":"1234567890"}
```

**Your AI Fill Configuration:**

```
Extract customer information from the context.
Use exact Salesforce API field names (FirstName, LastName, Email, Phone).
Format as JSON object per the example.
```

**Example: SharePoint Search Folders**

The integration provides this description for the `search_query` parameter:

```
Search query string to filter folders.
Use SharePoint search syntax (e.g., "ContentType:Folder AND Title:*Report*")
```

**Your AI Fill Configuration:**

```
Extract the folder name or keywords from user's request.
Format as SharePoint search query targeting folders only.
If searching for "Q4 Reports", use: "ContentType:Folder AND Title:*Q4*Report*"
```

<Frame>
  <img src="https://mintcdn.com/beamai/19PRqq2Lu11IakoJ/02-building-agents/agent-configuration/integrations/Screenshot%202025-11-07%20at%2023.14.26.png?fit=max&auto=format&n=19PRqq2Lu11IakoJ&q=85&s=2f95cd22fe4d6c2cd65e536859435b9b" alt="AI Fill parameter configuration" width="2418" height="1460" data-path="02-building-agents/agent-configuration/integrations/Screenshot 2025-11-07 at 23.14.26.png" />
</Frame>

### Writing Effective AI Fill Descriptions

<AccordionGroup>
  <Accordion title="Follow Integration Guidelines">
    **Start with the integration's format requirement**, then add your extraction logic.

    **Poor:**

    ```
    "Get customer data"
    ```

    **Good:**

    ```
    "Array format: ['Name','Email','Phone'] per integration requirement.
    Extract from conversation and format accordingly."
    ```
  </Accordion>

  <Accordion title="Reference Examples">
    **Use the exact examples** provided by the integration.

    **Poor:**

    ```
    "JSON object with fields"
    ```

    **Good:**

    ```
    "JSON format: {'FirstName':'John','LastName':'Doe'} as shown in integration example.
    Extract from customer context."
    ```
  </Accordion>

  <Accordion title="Specify Field Names">
    **Use exact API field names** as shown in the integration description.

    **Poor:**

    ```
    "Contact information"
    ```

    **Good:**

    ```
    "Use exact field names: FirstName, LastName, Email, Phone (not 'first name' or 'e-mail').
    Salesforce is case-sensitive."
    ```
  </Accordion>

  <Accordion title="Handle Edge Cases">
    **Add fallback behavior** when data might be missing.

    **Poor:**

    ```
    "Extract items"
    ```

    **Good:**

    ```
    "If items found, format as ['Item1','Item2']. If no items, return empty array [].
    Follow integration's array format."
    ```
  </Accordion>
</AccordionGroup>

### Linked Variables from Structured Outputs

Use Linked when previous nodes output clean, structured data that matches the integration's format.

**Example Workflow:**

```
Node 1: Extract Customer Info (Custom GPT)
├─ Structured Outputs:
│  ├─ customer_first_name: "John"
│  ├─ customer_last_name: "Doe"
│  ├─ customer_phone: "555-1234"
│  └─ salesforce_record_id: "003XX000004TmiI"

Node 2: Update Salesforce (Integration)
├─ Fields (Linked): {"FirstName":"${extract.customer_first_name}","LastName":"${extract.customer_last_name}","Phone":"${extract.customer_phone}"}
├─ Object Type (Static): "Contact"
└─ Record ID (Linked): ${extract.salesforce_record_id}
```

### Integration-Specific Format Patterns

Different integrations require specific data structures. Always check the parameter description.

**Arrays for List Operations:**

```
Google Sheets, Airtable: ["Item1", "Item2", "Item3"]
```

**JSON Objects for Record Operations:**

```
Salesforce, HubSpot: {"Field": "Value", "AnotherField": "Value"}
```

**Linked Record IDs:**

```
Airtable: ["recABC123"]  // Must be array even for single link
Salesforce: "003XX000004TmiI"  // String ID
```

**Search Queries:**

```
SharePoint: "ContentType:Folder AND Title:*keyword*"
Google Drive: "mimeType='application/vnd.google-apps.folder' and name contains 'Reports'"
```

## Integration Catalog

Beam provides 1500+ pre-built integrations organized by category.

<CardGroup cols={3}>
  <Card title="CRM" icon="address-book">
    Salesforce, HubSpot, Pipedrive, Zoho, Copper
  </Card>

  <Card title="Communication" icon="comments">
    Slack, Teams, Zoom, Discord, LinkedIn
  </Card>

  <Card title="Productivity" icon="list-check">
    Google Workspace, Microsoft 365, Notion, Calendly
  </Card>

  <Card title="Email" icon="envelope">
    Gmail, Outlook, SendGrid, Mailchimp
  </Card>

  <Card title="Documents" icon="file">
    Google Sheets, Airtable, Excel, Smartsheet
  </Card>

  <Card title="Storage" icon="database">
    Google Drive, Dropbox, Box, OneDrive, SharePoint
  </Card>

  <Card title="Marketing" icon="megaphone">
    Mailchimp, ActiveCampaign, Klaviyo
  </Card>

  <Card title="Operations" icon="gears">
    Freshdesk, Zendesk, Jira, Asana
  </Card>

  <Card title="Commerce" icon="cart-shopping">
    Shopify, WooCommerce, Stripe, PayPal
  </Card>

  <Card title="Analytics" icon="chart-line">
    Google Analytics, Mixpanel, Segment
  </Card>

  <Card title="Developer" icon="code">
    GitHub, GitLab, Bitbucket, Linear
  </Card>

  <Card title="AI & ML" icon="brain">
    OpenAI, Anthropic, Hugging Face
  </Card>
</CardGroup>

### Featured Integrations

<CardGroup cols={2}>
  <Card title="Salesforce" icon="salesforce">
    CRM platform for accounts, contacts, leads, and opportunities. Automate record creation, updates, and searches.
  </Card>

  <Card title="Gmail" icon="envelope">
    Email automation for sending, searching, drafting, and managing messages with Google Workspace integration.
  </Card>

  <Card title="Google Sheets" icon="table">
    Spreadsheet operations for appending rows, updating cells, reading data, and managing worksheets.
  </Card>

  <Card title="Slack" icon="slack">
    Team messaging for notifications, channel creation, file uploads, and thread posting.
  </Card>

  <Card title="Airtable" icon="grid">
    Database management for creating records, updating fields, querying data, and linking records.
  </Card>

  <Card title="HubSpot" icon="hubspot">
    Marketing and sales automation for contacts, deals, companies, and tickets.
  </Card>

  <Card title="Notion" icon="book">
    Workspace management for creating pages, updating databases, and organizing content.
  </Card>

  <Card title="Stripe" icon="stripe">
    Payment processing for charges, subscriptions, customers, and refunds.
  </Card>

  <Card title="Zendesk" icon="headset">
    Customer support for ticket management, user updates, and issue tracking.
  </Card>

  <Card title="Shopify" icon="shopping-cart">
    E-commerce operations for products, orders, customers, and inventory.
  </Card>
</CardGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Parameter Format Error">
    **Issue:** Integration rejects parameter format

    **Solutions:**

    * Check integration's parameter description for exact format
    * Follow the examples provided by the integration
    * Verify data types match (string vs number vs boolean)
    * Ensure arrays use correct structure (`["item"]` vs `"item"`)
    * Review integration documentation for field naming
  </Accordion>

  <Accordion title="AI Fill Produces Wrong Format">
    **Issue:** AI generates data in incorrect structure

    **Solutions:**

    * Reference the integration's format example in your description
    * Be explicit: "Follow this exact format" with specific example
    * Specify data types as shown in integration guidelines
    * Add validation: "Must match example format exactly"
    * Consider using Linked from structured output instead
  </Accordion>

  <Accordion title="Connection Authentication Failed">
    **Issue:** Cannot authenticate or connection expired

    **Solutions:**

    * Verify credentials are current and valid
    * Re-authenticate OAuth connections
    * Confirm API key has required permissions
    * Check OAuth scopes match integration requirements
  </Accordion>

  <Accordion title="Field Names Not Recognized">
    **Issue:** Integration doesn't recognize field names

    **Solutions:**

    * Use exact API field names from integration description
    * Check case sensitivity (e.g., `FirstName` not `firstname`)
    * Verify field exists in integration's schema
    * Review integration documentation for field mapping
  </Accordion>
</AccordionGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Selecting Tools" icon="wrench" href="/02-building-agents/agent-fundamentals/tools-integrations/tools-integrations">
    Learn how to add integrations to workflows
  </Card>

  <Card title="Variables & State" icon="arrow-right-arrow-left" href="/02-building-agents/agent-configuration/variables-state/variables-state">
    Understand variable fill methods in detail
  </Card>

  <Card title="Structured Outputs" icon="brackets-curly" href="/02-building-agents/agent-configuration/structured-outputs/structured-outputs">
    Design outputs for clean integration inputs
  </Card>

  <Card title="Custom Integrations" icon="code" href="/02-building-agents/advanced-patterns/custom-integrations/custom-integrations">
    Build custom API connections
  </Card>
</CardGroup>
