Skip to main content

Airbyte Salesforce Connector for AI platforms

Project description

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.

  • 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
  • Show me the notes and attachments for {customer}'s account

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

connector = SalesforceConnector(
    external_user_id="<your-scoped-token>",
    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

This connector supports the following entities and actions.

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

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

For detailed documentation on available actions and parameters, see this connector's full reference documentation.

For the service's official API docs, see the Salesforce API reference.

Version information

  • Package version: 0.1.51
  • Connector version: 1.0.5
  • Generated with Connector SDK commit SHA: 609c1d86c76b36ff699b57123a5a8c2050d958c3

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.51.tar.gz (132.1 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.51-py3-none-any.whl (150.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.51.tar.gz
Algorithm Hash digest
SHA256 52e6da588c0cfe8529af45f3ec65616c28e87f6a8dbd8f3aaaa90bfde5f22779
MD5 82add4c739d35180011060f3cb0ca6c4
BLAKE2b-256 41713b55a8414c852de716f0444064dcb1c118d3cbbb7be94deb66b0b41e1b3a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.51-py3-none-any.whl
Algorithm Hash digest
SHA256 7ff43cbd1f6163469b6def3ad875ffc14009b0f5d3f7c734efb2e0caeb370dc4
MD5 f4aaa62a1794657e139b8103a38d1d16
BLAKE2b-256 b6cfc1affd316fc69dec947d58eb2e0786e4db0ccfb62603914e13f5ab06187d

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