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.

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(
        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
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.96
  • Connector version: 1.0.13
  • Generated with Connector SDK commit SHA: 8c602f77c94fa829be7c1e10d063c5234b17dbef
  • 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.96.tar.gz (155.0 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.96-py3-none-any.whl (174.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.96.tar.gz
Algorithm Hash digest
SHA256 9de17c7dfaac6036dec859faca64f727ca690ed530ffff69b6fa123ccea7de52
MD5 38066f1c8ea103d1f21b23a4292c7988
BLAKE2b-256 ae7390c7c2df115b493c2d91c9e3772b05166516dfc590e60692f78e36f86d2f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.96-py3-none-any.whl
Algorithm Hash digest
SHA256 20aca267e6df3b11b7310d339e010108574cb34b4d6e1df352f8701332057f91
MD5 99bd3a247f82d159c8c62437a7036838
BLAKE2b-256 794237c44cf895f3b144d8f2edf6f3a9bbeabfb706fef3abda75afe263b5156c

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