andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2026-01-11 00:58:30 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

adjust aop to amp docs lang (#4179)
Some checks failed
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
Details
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Details
Check Documentation Broken Links / Check broken links (push) Has been cancelled
Details
Notify Downstream / notify-downstream (push) Has been cancelled
Details
Mark stale issues and pull requests / stale (push) Has been cancelled
Details

Browse Source 
* adjust aop to amp docs lang

* whoop no print
This commit is contained in:
Lorenze Jay
2026-01-05 15:30:21 -08:00
committed by GitHub
parent f8deb0fd18
commit 25c0c030ce
203 changed files with 5176 additions and 2715 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/en/enterprise/integrations/salesforce.mdx
View File

@@ -13,7 +13,7 @@ Enable your agents to manage customer relationships, sales processes, and data t
Before using the Salesforce integration, ensure you have:
- A [CrewAI AOP](https://app.crewai.com) account with an active subscription
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
- A Salesforce account with appropriate permissions
- Connected your Salesforce account through the [Integrations page](https://app.crewai.com/integrations)
@@ -21,7 +21,7 @@ Before using the Salesforce integration, ensure you have:
### 1. Connect Your Salesforce Account
1. Navigate to [CrewAI AOP Integrations](https://app.crewai.com/crewai_plus/connectors)
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
2. Find **Salesforce** in the Authentication Integrations section
3. Click **Connect** and complete the OAuth flow
4. Grant the necessary permissions for CRM and sales management
@@ -36,7 +36,9 @@ uv add crewai-tools
### 3. Environment Variable Setup
<Note>
To use integrations with `Agent(apps=[])`, you must set the `CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise Token.
To use integrations with `Agent(apps=[])`, you must set the
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
Token.
</Note>
```bash
@@ -65,6 +67,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Title` (string, optional): Title of the contact, such as CEO or Vice President
- `Description` (string, optional): A description of the Contact
- `additionalFields` (object, optional): Additional fields in JSON format for custom Contact fields
</Accordion>
<Accordion title="salesforce/create_record_lead">
@@ -81,6 +84,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Status` (string, optional): Lead Status - Use Connect Portal Workflow Settings to select Lead Status
- `Description` (string, optional): A description of the Lead
- `additionalFields` (object, optional): Additional fields in JSON format for custom Lead fields
</Accordion>
<Accordion title="salesforce/create_record_opportunity">
@@ -96,6 +100,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `OwnerId` (string, optional): The Salesforce user assigned to work on this Opportunity
- `NextStep` (string, optional): Description of next task in closing Opportunity
- `additionalFields` (object, optional): Additional fields in JSON format for custom Opportunity fields
</Accordion>
<Accordion title="salesforce/create_record_task">
@@ -114,6 +119,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `isReminderSet` (boolean, optional): Whether reminder is set
- `reminderDateTime` (string, optional): Reminder Date/Time in ISO format
- `additionalFields` (object, optional): Additional fields in JSON format for custom Task fields
</Accordion>
<Accordion title="salesforce/create_record_account">
@@ -126,12 +132,14 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Phone` (string, optional): Phone number
- `Description` (string, optional): Account description
- `additionalFields` (object, optional): Additional fields in JSON format for custom Account fields
</Accordion>
<Accordion title="salesforce/create_record_any">
**Description:** Create a record of any object type in Salesforce.
**Note:** This is a flexible tool for creating records of custom or unknown object types.
</Accordion>
</AccordionGroup>
@@ -150,6 +158,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Title` (string, optional): Title of the contact
- `Description` (string, optional): A description of the Contact
- `additionalFields` (object, optional): Additional fields in JSON format for custom Contact fields
</Accordion>
<Accordion title="salesforce/update_record_lead">
@@ -167,6 +176,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Status` (string, optional): Lead Status
- `Description` (string, optional): A description of the Lead
- `additionalFields` (object, optional): Additional fields in JSON format for custom Lead fields
</Accordion>
<Accordion title="salesforce/update_record_opportunity">
@@ -183,6 +193,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `OwnerId` (string, optional): The Salesforce user assigned to work on this Opportunity
- `NextStep` (string, optional): Description of next task in closing Opportunity
- `additionalFields` (object, optional): Additional fields in JSON format for custom Opportunity fields
</Accordion>
<Accordion title="salesforce/update_record_task">
@@ -201,6 +212,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `isReminderSet` (boolean, optional): Whether reminder is set
- `reminderDateTime` (string, optional): Reminder Date/Time in ISO format
- `additionalFields` (object, optional): Additional fields in JSON format for custom Task fields
</Accordion>
<Accordion title="salesforce/update_record_account">
@@ -214,12 +226,14 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `Phone` (string, optional): Phone number
- `Description` (string, optional): Account description
- `additionalFields` (object, optional): Additional fields in JSON format for custom Account fields
</Accordion>
<Accordion title="salesforce/update_record_any">
**Description:** Update a record of any object type in Salesforce.
**Note:** This is a flexible tool for updating records of custom or unknown object types.
</Accordion>
</AccordionGroup>
@@ -231,6 +245,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): Record ID of the Contact
</Accordion>
<Accordion title="salesforce/get_record_by_id_lead">
@@ -238,6 +253,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): Record ID of the Lead
</Accordion>
<Accordion title="salesforce/get_record_by_id_opportunity">
@@ -245,6 +261,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): Record ID of the Opportunity
</Accordion>
<Accordion title="salesforce/get_record_by_id_task">
@@ -252,6 +269,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): Record ID of the Task
</Accordion>
<Accordion title="salesforce/get_record_by_id_account">
@@ -259,6 +277,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordId` (string, required): Record ID of the Account
</Accordion>
<Accordion title="salesforce/get_record_by_id_any">
@@ -267,6 +286,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `recordType` (string, required): Record Type (e.g., "CustomObject__c")
- `recordId` (string, required): Record ID
</Accordion>
</AccordionGroup>
@@ -282,6 +302,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sortDirection` (string, optional): Sort direction - Options: ASC, DESC
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/search_records_lead">
@@ -293,6 +314,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sortDirection` (string, optional): Sort direction - Options: ASC, DESC
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/search_records_opportunity">
@@ -304,6 +326,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sortDirection` (string, optional): Sort direction - Options: ASC, DESC
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/search_records_task">
@@ -315,6 +338,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sortDirection` (string, optional): Sort direction - Options: ASC, DESC
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/search_records_account">
@@ -326,6 +350,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `sortDirection` (string, optional): Sort direction - Options: ASC, DESC
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/search_records_any">
@@ -336,6 +361,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `filterFormula` (string, optional): Filter search criteria
- `includeAllFields` (boolean, optional): Include all fields in results
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
</AccordionGroup>
@@ -348,6 +374,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/get_record_by_view_id_lead">
@@ -356,6 +383,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/get_record_by_view_id_opportunity">
@@ -364,6 +392,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/get_record_by_view_id_task">
@@ -372,6 +401,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/get_record_by_view_id_account">
@@ -380,6 +410,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
<Accordion title="salesforce/get_record_by_view_id_any">
@@ -389,6 +420,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `recordType` (string, required): Record Type
- `listViewId` (string, required): List View ID
- `paginationParameters` (object, optional): Pagination settings with pageCursor
</Accordion>
</AccordionGroup>
@@ -409,6 +441,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Field description
- `helperText` (string, optional): Helper text shown on hover
- `defaultFieldValue` (string, optional): Default field value
</Accordion>
<Accordion title="salesforce/create_custom_field_lead">
@@ -425,6 +458,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Field description
- `helperText` (string, optional): Helper text shown on hover
- `defaultFieldValue` (string, optional): Default field value
</Accordion>
<Accordion title="salesforce/create_custom_field_opportunity">
@@ -441,6 +475,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Field description
- `helperText` (string, optional): Helper text shown on hover
- `defaultFieldValue` (string, optional): Default field value
</Accordion>
<Accordion title="salesforce/create_custom_field_task">
@@ -457,6 +492,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Field description
- `helperText` (string, optional): Helper text shown on hover
- `defaultFieldValue` (string, optional): Default field value
</Accordion>
<Accordion title="salesforce/create_custom_field_account">
@@ -473,12 +509,14 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `description` (string, optional): Field description
- `helperText` (string, optional): Helper text shown on hover
- `defaultFieldValue` (string, optional): Default field value
</Accordion>
<Accordion title="salesforce/create_custom_field_any">
**Description:** Deploy custom fields for any object type.
**Note:** This is a flexible tool for creating custom fields on custom or unknown object types.
</Accordion>
</AccordionGroup>
@@ -490,6 +528,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
**Parameters:**
- `query` (string, required): SOQL Query (e.g., "SELECT Id, Name FROM Account WHERE Name = 'Example'")
</Accordion>
<Accordion title="salesforce/create_custom_object">
@@ -500,6 +539,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `pluralLabel` (string, required): Plural Label (e.g., "Accounts")
- `description` (string, optional): A description of the Custom Object
- `recordName` (string, required): Record Name that appears in layouts and searches (e.g., "Account Name")
</Accordion>
<Accordion title="salesforce/describe_action_schema">
@@ -510,6 +550,7 @@ CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
- `operation` (string, required): Operation Type (e.g., "CREATE_RECORD" or "UPDATE_RECORD")
**Note:** Use this function first when working with custom objects to understand their schema before performing operations.
</Accordion>
</AccordionGroup>
@@ -639,5 +680,6 @@ This comprehensive documentation covers all the Salesforce tools organized by fu
### Getting Help
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
Contact our support team for assistance with Salesforce integration setup or troubleshooting.
Contact our support team for assistance with Salesforce integration setup or
troubleshooting.
</Card>