Skip to content

Connect Salesforce Knowledge

Push your published Topicary documentation to Salesforce Knowledge as knowledge articles. The integration maps topics to Knowledge__kav records and keeps them in sync with your published content.

Before you begin

This feature requires the Enterprise capability tier (the Business ). During the beta, every project is on the free Solo tier, so this feature is locked by default: go to Settings ▸ Billing and request Enterprise access to unlock it.

Only project members with the Admin can configure this feature. Authors and Reviewers do not have access to these settings.

Connect your Salesforce org

  1. Go to Settings in the sidebar.

  2. Open the Integrations tab.

  3. Click Add Integration and select the Salesforce provider.

  4. Enter the connection credentials:

    Field

    Value

    Instance URL

    Your org's My Domain URL, for example, https://yourorg.my.salesforce.com

    Client ID

    Your Connected App's consumer key

    Client Secret

    Your Connected App's consumer secret

    Username

    The Salesforce integration user's login

    Password

    That user's password

    Security Token

    That user's security token

  5. Click Test Connection to verify the credentials.

  6. Once the connection succeeds, give the integration a name and click Create.

Use a dedicated Salesforce integration user rather than a personal account. This ensures the connection remains active if team members leave.

Sync content

  1. Go to Settings > Integrations and select your Salesforce connection.

  2. Select the publication target whose content should sync.

  3. Click Sync Now.

Each topic becomes a Knowledge article with the title and body set from published content. If an article with a matching UrlName already exists, it is updated rather than duplicated.

Only published content is synced. Draft and in-review topics are not pushed to Salesforce.

Sync behavior

  • New topics create new Knowledge__kav records.

  • Updated topics update the existing article with the latest published content.

Content comparison uses a content hash. Unchanged articles are skipped to avoid unnecessary API calls.

Sync pushes published content to Salesforce. It does not delete Knowledge articles. If you remove a topic in Topicary, remove or archive the matching article in Salesforce manually.

Divergence detection

Topicary detects when Knowledge articles have been edited directly in Salesforce since the last sync. A warning badge appears on the Integrations tab showing which articles have been modified outside of Topicary. When you trigger a sync, you will see a warning before overwriting those external changes, giving you the opportunity to review the differences first.

Syncing overwrites Salesforce Knowledge articles with Topicary content. Any edits made directly in Salesforce will be lost on the next sync.

See also

Was this page helpful?