Skip to content

Salesforce Connector

Connect Salesforce orgs. Shared OAuth flow uses integration: "salesforce".

Base URL

BASE_URL = "https://api.fermi.dev/public/v1"

Authentication

Authorization: Bearer <service-actor-token>

Required Scopes: connectors:read, connectors:write, connectors:sync

Connect

POST /connect/integrations/connect-session

{
  "integration": "salesforce"
}

Response: { "sessionToken": "..." }

List connections

GET /connect/integrations/connections?providerConfigKey=salesforce

User info

GET /connect/integrations/user-info?connectionId={connectionId}&providerConfigKey=salesforce

Resolves the Salesforce instance URL from the stored connection.

Metadata and sync

Salesforce metadata writes do not enqueue sync unless triggerSyncEnqueue is true.

POST /connect/integrations/connection-metadata

{
  "connectionId": "CONNECTION_ID",
  "providerConfigKey": "salesforce",
  "metadata": {},
  "triggerSyncEnqueue": true
}

POST /sync/enqueue

{
  "connectionId": "CONNECTION_ID",
  "providerKey": "salesforce"
}

Summary

Method Path
POST /connect/integrations/connect-session
GET /connect/integrations/connections?providerConfigKey=salesforce
GET /connect/integrations/user-info
POST /connect/integrations/connection-metadata
POST /sync/enqueue

Next Steps