Documentation menu

Connectors

Salesforce

A Lightning component on Case pages that starts translated calls.

A Lightning component for Case record pages. Start translated call opens a voice or video call in which the agent and the case's contact each speak their own language. The agent joins in a new tab; the customer's link can be copied or emailed to the contact.

Install#

The package brings the component, its Apex class, the Spiiksi named and external credentials, and a Spiiksi agent permission set. You add only the key.

  1. In Spiiksi, create a key for Salesforce: API & integrations → Connectors → Salesforce → Create key. It gets only the calls:write scope.
  2. Install the package. Use the Install in Salesforce button on that tab if it's there. Otherwise download spiiksi-salesforce.zip, unzip it and deploy it with the Salesforce CLI:
Shell
sf project deploy start --source-dir force-app --target-org <your org> \
  --test-level RunSpecifiedTests --tests SpiiksiServiceTest
  1. In Setup: Named Credentials → External Credentials → Spiiksi. Edit the principal Spiiksi and add an authentication parameter ApiKey with your key.
  2. Assign the Spiiksi agent permission set to your agents. It lets them run the component and call through the credential.
  3. In Lightning App Builder, add Spiiksi translated call to the Case record page.

Notes#

  • The key lives in the external credential; Apex and agents never see it. To change it, edit the ApiKey parameter.
  • Calls carry external_id: "sf-case-<case number>" and metadata.salesforce_case (the case id).
  • SpiiksiServiceTest mocks the callout, so deploying doesn't call Spiiksi.