SFHooks Docs

Connect a Salesforce org

Authorize an org, choose a replay preset, and read connection statuses.

Connect an org

Open the Connections page and start a new connection. You'll be redirected to Salesforce to sign in and authorize SFHooks, then returned to the app.

  1. On the Connections page, choose to connect a Salesforce org.
  2. Sign in to Salesforce and approve the requested access.
  3. You're redirected back; the connection appears and begins streaming once it reaches the active state.

SFHooks stores the OAuth tokens encrypted at rest and refreshes the access token transparently, so you don't re-authorize on a schedule.

Before you connect

SFHooks delivers Change Data Capture events, so the Salesforce objects you want to stream must have CDC enabled in that org (Setup → Change Data Capture). Standard and custom objects (for example Account or Invoice__c) are both supported once CDC is turned on for them.

Where streaming resumes (replay preset)

Salesforce keeps a short replay buffer of recent change events. The connection's replay preset controls where ingestion resumes if SFHooks restarts or reconnects:

  • Latest — resume from the most recent events only. Best for most setups; you won't reprocess a backlog.
  • Earliest — resume from the oldest events still in Salesforce's buffer. Useful to catch up after a planned pause.

Connection statuses

Connection lifecycle
  • Pending — OAuth started but not yet completed.
  • Active — authenticated and streaming change events.
  • Error — authentication failed or was lost; re-authorize to recover.
  • Revoked — you disconnected the org; streaming has stopped.

Multiple orgs & disconnecting

You can connect more than one Salesforce org; the number of connections allowed depends on your plan. Revoking a connection from the Connections page stops ingestion and invalidates the stored tokens — reconnect any time to resume.