Skip to main content

Airbyte Salesforce Connector for AI platforms

Project description

Salesforce

The Salesforce agent connector is a Python package that equips AI agents to interact with Salesforce through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

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. If your Airbyte client can access multiple organizations, also set organization_id.

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, AirbyteAuthConfig

connector = SalesforceConnector(
    auth_config=AirbyteAuthConfig(
        customer_name="<your_customer_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        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
Sobjects List
Accounts List, Get, API Search, Search
Contacts List, Get, API Search, Search
Leads List, Get, API Search, Search
Opportunities List, Get, API Search, Search
Tasks List, Get, API Search, 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

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

Salesforce API docs

See the official Salesforce API reference.

Version information

  • Package version: 0.1.119
  • Connector version: 1.0.15
  • Generated with Connector SDK commit SHA: fbc0bacdabf9b1de67621333cd97edee9c444de4
  • Changelog: View changelog

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_salesforce-0.1.119.tar.gz (176.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_agent_salesforce-0.1.119-py3-none-any.whl (197.6 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_agent_salesforce-0.1.119.tar.gz.

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.119.tar.gz
Algorithm Hash digest
SHA256 c350c529e972a743a96ddd9c98d5506da82d7de1d714b3eabe1d874534ee0305
MD5 361f6dca8a766b84307c3b39c3a44100
BLAKE2b-256 1e6a4e9e9ffef5f66e303ee80d617922652f0a1fa7af396a770ba8810296253a

See more details on using hashes here.

File details

Details for the file airbyte_agent_salesforce-0.1.119-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.119-py3-none-any.whl
Algorithm Hash digest
SHA256 074711596d995b554f36b78aa69c4d44cf402b9f09a828b91ea1eb4f66ab9550
MD5 4b96b5ee0e2f898adc78ff6aa7724733
BLAKE2b-256 76e99961145d66af4a423bb8b20e768fd3f07aa9b884a7259568e004d8bf0c32

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page