Documentation

Salesforce Agent

The Salesforce Agent is a specialized component that integrates with Salesforce CRM to provide natural language interactions with your sales and customer data.

Salesforce Agent Component

Salesforce Agent interface and configuration options

Configuration Parameters

Required Parameters

  • Tool: User question processing
  • Language Model: The AI model
  • Salesforce Instance URL: Instance endpoint
  • Tool Instructions: Processing guidelines
  • Salesforce Security Token: Authentication token

Output Format

{
  "queryResult": {
    "data": array,
    "message": string,
    "metadata": {
      "objectType": string,
      "recordCount": number,
      "executionTime": string
    }
  }
}

Example Usage

const salesforceAgent = new SalesforceAgent({
  tool: "user-question",
  languageModel: "gpt-4",
  salesforceInstanceUrl: "https://your-instance.salesforce.com",
  toolInstructions: "Process Salesforce queries and return formatted results",
  salesforceSecurityToken: "YOUR_SECURITY_TOKEN"
});

const result = await salesforceAgent.process({
  input: "Show me all opportunities closing this quarter"
});

Best Practices

  • Secure token management
  • Implement API limits
  • Cache frequent queries
  • Monitor API usage
  • Regular security audits