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_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
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

Authentication and configuration

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

Salesforce API docs

See the official Salesforce API reference.

Version information

  • Package version: 0.1.69
  • Connector version: 1.0.9
  • Generated with Connector SDK commit SHA: 37060312946462d49e9dbca15489903d66ebddae
  • 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.69.tar.gz (148.7 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.69-py3-none-any.whl (168.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.69.tar.gz
Algorithm Hash digest
SHA256 8b40c734d69573292f87711e22ef0a19369de51a83f0d81c5ae14b20020daa3c
MD5 32e6628ba6ae5d07219d4696c22e5777
BLAKE2b-256 de3db460adbaaa82aa24ed99dc64a0023ff37b23b8f08cf9dbbe5bc81eed0aae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_salesforce-0.1.69-py3-none-any.whl
Algorithm Hash digest
SHA256 ab01e5e9d2565eb45286c46effaa036625094be425d70c39d843556e2159a294
MD5 7aa9c4b2eb832a4537ec81ba9a2baa9c
BLAKE2b-256 7031cef3c2983720995355df96e2cf15274ecf559202de41ddba2c814dada93e

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