airbyte-agent-salesforce 0.1.75

Airbyte Salesforce Connector for AI platforms

Salesforce agent connector

Salesforce is a cloud-based CRM platform that helps businesses manage customer relationships, sales pipelines, and business operations. This connector provides access to accounts, contacts, leads, opportunities, tasks, events, campaigns, cases, notes, and attachments for sales analytics and customer relationship management.

Example questions

The Salesforce connector is optimized to handle prompts like these.

• List recent contacts in my Salesforce account
• List open cases in my Salesforce account
• Show me the notes and attachments for a recent account
• Show me my top 5 opportunities this month
• List all contacts from {company} in the last quarter
• Search for leads in the technology sector with revenue over $10M
• What trends can you identify in my recent sales pipeline?
• Summarize the open cases for my key accounts
• Find upcoming events related to my most important opportunities
• Analyze the performance of my recent marketing campaigns
• Identify the highest value opportunities I'm currently tracking

Unsupported questions

The Salesforce connector isn't currently able to handle prompts like these.

• Create a new lead for {person}
• Update the status of my sales opportunity
• Schedule a follow-up meeting with {customer}
• Delete this old contact record
• Send an email to all contacts in this campaign

Installation

uv pip install airbyte-agent-salesforce

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_salesforce import SalesforceConnector
from airbyte_agent_salesforce.models import SalesforceAuthConfig

connector = SalesforceConnector(
    auth_config=SalesforceAuthConfig(
        refresh_token="<OAuth refresh token for automatic token renewal>",
        client_id="<Connected App Consumer Key>",
        client_secret="<Connected App Consumer Secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@SalesforceConnector.tool_utils
async def salesforce_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_salesforce import SalesforceConnector
from airbyte_agent_salesforce._vendored.connector_sdk.types import AirbyteHostedAuthConfig

connector = SalesforceConnector(
    auth_config=AirbyteHostedAuthConfig(
        external_user_id="<your_external_user_id>",
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@SalesforceConnector.tool_utils
async def salesforce_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity	Actions
Accounts	List, Get, API Search
Contacts	List, Get, API Search
Leads	List, Get, API Search
Opportunities	List, Get, API Search
Tasks	List, Get, API Search
Events	List, Get, API Search
Campaigns	List, Get, API Search
Cases	List, Get, API Search
Notes	List, Get, API Search
Content Versions	List, Get, Download
Attachments	List, Get, Download
Query	List

Authentication and configuration

For all authentication and configuration options, see the connector's authentication documentation.

Salesforce API docs

See the official Salesforce API reference.

Version information

• Package version: 0.1.75
• Connector version: 1.0.11
• Generated with Connector SDK commit SHA: 5c699b63de47ab09d9e52e38d1c61f7f994da24d
• Changelog: View changelog