@fdekit/connector-salesforce
v0.5.3
Published
Salesforce CRM connector adapter for FDEKit
Readme
@fdekit/connector-salesforce
Purpose
@fdekit/connector-salesforce lets FDEKit agents create Salesforce activity records through both salesforce.task.create and the common crm.note.create capability. Local mode returns deterministic Salesforce activity records; API mode creates Salesforce Task records through the REST API.
Who should use this package
- Deployment authors who want CRM activity creation in Salesforce.
- Recipe authors using the common
crm.note.createcapability across HubSpot and Salesforce. - Connector contributors maintaining Salesforce API behavior and local-mode parity.
Choose HubSpot when the customer CRM is HubSpot. Choose a custom connector for another CRM.
5-minute quick example
import { defineDeployment } from '@fdekit/core';
import { salesforceConnector } from '@fdekit/connector-salesforce';
const salesforce = salesforceConnector({
mode: process.env.FDEKIT_CONNECTOR_MODE === 'api' ? 'api' : 'local',
instanceUrl: process.env.SALESFORCE_INSTANCE_URL,
accessTokenEnv: 'SALESFORCE_ACCESS_TOKEN',
});
export default defineDeployment({
name: 'salesforce-sales-research',
environment: 'local',
connectors: { salesforce },
providers: {
mock: { name: 'mock' },
},
agents: {
// ...
},
});Set SALESFORCE_INSTANCE_URL and SALESFORCE_ACCESS_TOKEN for API mode.
Public API surface
Import from the package root:
import { salesforceConnector } from '@fdekit/connector-salesforce';
import type { SalesforceConnectorOptions, CreateSalesforceTaskResult } from '@fdekit/connector-salesforce';Root exports include salesforceConnector, SalesforceConnectorConfig, SalesforceConnectorMode, SalesforceConnectorOptions, CreateSalesforceTaskArgs, and CreateSalesforceTaskResult. The connector family is summarized in the public API index: Public API Reference.
Stability/backward-compat notes
@fdekit/connector-salesforce is public but pre-1.0. The package-root factory, option/result types, local/API modes, salesforce.task.create, and crm.note.create tool names are compatibility-sensitive.
Subpath imports are internal. Keep local mode deterministic so demos and tests do not require Salesforce credentials.
See also
- Connector authoring contracts: @fdekit/core
- Runtime execution: @fdekit/runtime
- CRM connector neighbor: HubSpot
- Connector family: customer API, codebase, GitHub, Slack, Jira, Linear, Postgres, k6
