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.describe
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.describe
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.50
  • Connector version: 1.0.5
  • Generated with Connector SDK commit SHA: 416466da4970ae5fd6c7f2c658a68e047e51efd9

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.50.tar.gz (127.3 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.50-py3-none-any.whl (146.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.50.tar.gz
Algorithm Hash digest
SHA256 7150a0f84645de1f798e3ca78547acf42d5ae3c28f159da9de94534a4b25495c
MD5 cb377a4f09be5ab47951b24c690ea2de
BLAKE2b-256 f506e5a7273d4b69c16664aa1a32dfedf7e425ef2bd36598739dd639c3792fce

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.50-py3-none-any.whl
Algorithm Hash digest
SHA256 445112f8efcfb08ab5ce8a46bebfcfdc1efaa5b4692448698586d7861d50f032
MD5 085926dbf853c766b7bc4b7fdd707488
BLAKE2b-256 3316298103a65e3d55214402dcdfbd6ec7a59a4cecde5b306480eae933d17a86

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