Guides
Start typing to search…

Bidirectional Connector - Setup Guide

Purpose

This guide explains how to set up OAuth and object access so the Authenticx Salesforce API Connector can:

  1. Authenticate to Salesforce with OAuth client credentials
  2. Look up a specific object (Task, Case, etc.) record using a field that stores the call identifier
  3. Patch a call summary into an object field such as Description or a custom text field

This is a server to server integration. It does not use an interactive browser login.

What You Must Decide Before Setup

Confirm these four design choices before starting.

  1. Which Salesforce object (Task, Case, etc.) field stores the associated call identifier (Authenticx ClientCallId) Example: sessionId__c

  2. Whether that lookup field is marked in Salesforce as an External ID

  3. Which writable object field should receive the summary

    • Example: Description
    • Example: Authenticx_Call_Summary__c

  4. Whether the summary should overwrite the target field or be appended to existing content

Prerequisites

You will need:

  1. Salesforce admin access
  2. API access enabled in the Salesforce org
  3. An object (Task, Case, etc.) field that stores the call identifier
  4. A writable target field for the summary

Step 1: Create or Identify the Task Lookup Field

In Salesforce, create or confirm the object (Task, Case, etc.) field that will hold the Authenticx ClientCallId.

Recommended characteristics:

  • Type should be Text
  • Field should be populated with the same value that arrives to Authenticx as ClientCallId
  • Field should be unique (if possible)
  • Field should be marked as an External ID

Example field:

Task.ConversationId__c

If the field is not an External ID, the integration still works but will use a SOQL query instead of the external ID endpoint.

Step 2: Create or Confirm the Summary Target Field

Choose the field that will receive the call summary.

Possible choices:

  • Task.Description
  • A custom long text field such as Task.Authenticx_Call_Summary__c

Recommendations:

  • Use a long text area if you want to preserve larger summaries
  • Use Description only if the business is comfortable mixing Authenticx content with agent notes
  • If append behavior is required, choose a text field that can hold multiple lines

Step 3: Create the Integration User, Permission Set, External Client App, and OAuth Credentials

The interactive walkthrough below covers everything needed for this step:

  • Creating a dedicated Salesforce integration user with the correct license and profile
  • Creating a permission set with the required system permissions and assigning it to the integration user
  • Creating an External Client App with OAuth and Client Credentials Flow enabled
  • Configuring the OAuth policies and Run As user
  • Retrieving the Consumer Key and Consumer Secret

Note on permissions: This walkthrough uses “Modify All Data” for simplicity. If your organization follows a more limited permission model in Salesforce, you can grant the integration user Edit access only to the specific object(s) and fields in scope for the integration.

Expand the walkthrough below and follow each step in order.

Once complete, securely provide the Consumer Key and Consumer Secret to your Authenticx onboarding team.

Step 4: Provide the Salesforce Base Domain

Provide the base Salesforce domain used for OAuth token requests.

Examples:

https://your-domain.my.salesforce.com

For production orgs using My Domain, the safest choice is usually your My Domain URL.

The integration requests tokens from:

POST {SalesforceDomain}/services/oauth2/token

with:

grant_type=client_credentials
client_id=<client id or consumer key>
client_secret=<client secret or consumer secret>

Customer Handoff Checklist

Before go live, provide the following to your Authenticx onboarding team:

  1. Salesforce base domain
  2. Client ID or Consumer Key
  3. Client Secret or Consumer Secret
  4. Task lookup field API name
  5. Whether the lookup field is an External ID
  6. Summary target field API name
  7. Whether intended behavior is overwrite or append
  8. The API name of the field in Salesforce where the ClientCallId value originates, if different from the lookup field specified in item 4

Updated 7 days ago