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.48
  • Connector version: 1.0.5
  • Generated with Connector SDK commit SHA: 49e6dfe93fc406c8d2ed525372608fa2766ebece

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.48.tar.gz (127.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.48-py3-none-any.whl (145.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.48.tar.gz
Algorithm Hash digest
SHA256 c30a7c39275793c0f0bfe092f99497931bcca850e6d6d0161618a7f30d447fd2
MD5 ab8a09824641add421499571ba5a9641
BLAKE2b-256 02b4bc34f1868847f1a6bd48c1492d255b38aea0bc29ce4b87d02c71b2cb4002

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.48-py3-none-any.whl
Algorithm Hash digest
SHA256 98f152643266fc0b3950dcc483a8252427a79d64ad2f3be96d7a07d26672f187
MD5 e621d8349ae577cd8d1da19619dd88c7
BLAKE2b-256 949bae8d213aad220f66cf44588b367c44f64042afa1c4685d85cfd6110e4bc9

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