b2afd6e91e
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io> Co-authored-by: octavia-bot[bot] <108746235+octavia-bot[bot]@users.noreply.github.com>
78 lines
3.4 KiB
Markdown
78 lines
3.4 KiB
Markdown
# Airbyte Salesforce AI 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
|
|
|
|
- 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 [customerX]'s account
|
|
|
|
## Unsupported Questions
|
|
|
|
- Create a new lead for [personX]
|
|
- Update the status of my sales opportunity
|
|
- Schedule a follow-up meeting with [customerX]
|
|
- Delete this old contact record
|
|
- Send an email to all contacts in this campaign
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
uv pip install airbyte-ai-salesforce
|
|
```
|
|
|
|
## Usage
|
|
|
|
```python
|
|
from airbyte_ai_salesforce import SalesforceConnector, SalesforceAuthConfig
|
|
|
|
connector = SalesforceConnector(
|
|
auth_config=SalesforceAuthConfig(
|
|
refresh_token="...",
|
|
client_id="...",
|
|
client_secret="..."
|
|
)
|
|
)
|
|
result = connector.accounts.list()
|
|
```
|
|
|
|
## Documentation
|
|
|
|
| Entity | Actions |
|
|
|--------|---------|
|
|
| Accounts | [List](./REFERENCE.md#accounts-list), [Get](./REFERENCE.md#accounts-get), [Search](./REFERENCE.md#accounts-search) |
|
|
| Contacts | [List](./REFERENCE.md#contacts-list), [Get](./REFERENCE.md#contacts-get), [Search](./REFERENCE.md#contacts-search) |
|
|
| Leads | [List](./REFERENCE.md#leads-list), [Get](./REFERENCE.md#leads-get), [Search](./REFERENCE.md#leads-search) |
|
|
| Opportunities | [List](./REFERENCE.md#opportunities-list), [Get](./REFERENCE.md#opportunities-get), [Search](./REFERENCE.md#opportunities-search) |
|
|
| Tasks | [List](./REFERENCE.md#tasks-list), [Get](./REFERENCE.md#tasks-get), [Search](./REFERENCE.md#tasks-search) |
|
|
| Events | [List](./REFERENCE.md#events-list), [Get](./REFERENCE.md#events-get), [Search](./REFERENCE.md#events-search) |
|
|
| Campaigns | [List](./REFERENCE.md#campaigns-list), [Get](./REFERENCE.md#campaigns-get), [Search](./REFERENCE.md#campaigns-search) |
|
|
| Cases | [List](./REFERENCE.md#cases-list), [Get](./REFERENCE.md#cases-get), [Search](./REFERENCE.md#cases-search) |
|
|
| Notes | [List](./REFERENCE.md#notes-list), [Get](./REFERENCE.md#notes-get), [Search](./REFERENCE.md#notes-search) |
|
|
| Content Versions | [List](./REFERENCE.md#content-versions-list), [Get](./REFERENCE.md#content-versions-get), [Download](./REFERENCE.md#content-versions-download) |
|
|
| Attachments | [List](./REFERENCE.md#attachments-list), [Get](./REFERENCE.md#attachments-get), [Download](./REFERENCE.md#attachments-download) |
|
|
| Query | [List](./REFERENCE.md#query-list) |
|
|
|
|
|
|
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
|
|
|
|
For the service's official API docs, see [Salesforce API Reference](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_rest.htm).
|
|
|
|
## Version Information
|
|
|
|
**Package Version:** 0.1.4
|
|
|
|
**Connector Version:** 1.0.3
|
|
|
|
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb |