Installation & User Guide

1. Log in and navigate to the installation URL.

2. Select Install for All Users.

3. Acknowledge the non-Salesforce AppExchange warning and click Install.

   

4. Approve third-party access to the Kudosity API — tick the checkbox and click Continue.

   

5. Wait approximately 1 minute for installation to complete, then click Done.

If installation is taking longer than expected, you will receive an email when it completes.

Upgrading from a previous version? Navigate to the same install URL while logged into your existing org. Salesforce will detect the existing package and prompt you to upgrade rather than reinstall. If you encounter a duplicate metadata error, go to Setup → Custom Metadata Types → Credentials and remove the existing record before reinstalling.

The package installs three permission sets. Assign one to every person who needs the app — by default, only the administrator who installed the package has access.

Assignment path: Setup → Permission Sets → select the permission set → Manage Assignments → Add Assignments

1. In Salesforce Setup, open Permission Sets.

2. Open the Kudosity permission set that matches the person's role.

3. Select Manage Assignments, then Add Assignments.

4. Select the users who need that role and save.

5. Test while logged in as the assigned user — not as a System Administrator.

Which permission set to assign

Assigning a Kudosity permission set does not grant access to your CRM data. Access to Lead, Contact, Campaign, Case, Opportunity and custom objects stays controlled by your existing Salesforce profiles, permission sets, sharing rules and field-level security. A sender also needs Read access to the exact mobile phone field selected in the messaging screen, the country field if one is used, and every field used as a merge field.

Record-level access by permission set

Inbound SMS and link hit records are created by the integration rather than by users, which is why Kudosity User has no Create permission on them and no role has Create on link hits.

All three permission sets make the same six Kudosity tabs visible, including Messaging and Settings. A Kudosity View Only user can open the Messaging tab but cannot send, because the permission set grants no sending access. Hide tabs at profile level if you need them out of sight entirely.

Use least privilege. Do not assign Kudosity Admin to work around a missing field, record or component. Resolve the specific object permission, field-level security, sharing rule, page visibility or Sender ID assignment instead.

1. Open the App Launcher (9-dot grid icon, top-left navigation bar) and search for Kudosity.

2. Click the Kudosity app result — you will be taken to the setup screen.

3. Navigate to your Kudosity account Settings and copy your API Key and API Secret.

If there is no API Secret shown in your Kudosity account, click Update Profile at the bottom of the Settings screen to generate one.

4. Paste your API Key and API Secret into the setup screen and click Connect.

Once connected, configure your global defaults.

Default Destination Country automatically formats contact mobile numbers into the correct international format for delivery. Where no country is defined on a contact record, this will be used as the fallback.

Default Sender ID pre-selects a Sender ID across your SMS campaigns and conversation screens to streamline workflow. It can be overridden at any time.

Select your options and click Save.

Administrators can assign specific default Sender IDs and Country settings to individual Salesforce users. This ensures users only have access to the Sender IDs appropriate for their role and prevents users from accessing Sender IDs assigned to other team members.

To configure:

1. In the Kudosity app, navigate to Settings.

2. Under User Specific Settings, select the user you wish to configure.

3. Assign their default Sender ID and Country.

4. Click Save.

To let users send and receive SMS directly from a Lead, Contact, Case or Opportunity record, add the Kudosity Conversation component to that object's Lightning record page. See 1-to-1 SMS Conversations

This step enables live delivery reporting, inbound replies, and link hit notifications back into Salesforce. This uses Salesforce's External Client App (ECA) framework.

Deploy the External Client App

1. In the Kudosity setup screen, locate the Live Responses / Reporting section.

2. If you see a Setup External Client App button, click it.

3. Wait 30–60 seconds for the spinner to complete — the ECA is being deployed in the background.

4. Once complete, the screen will show "Your ECA is ready" with a Consumer Key input field.

If Live Responses already shows CONNECTED and no button appears, the ECA is already set up — no action needed.

Copy Your Consumer Key

1. Click Open External Client App Manager — this opens Salesforce Setup in a new tab.

2. Find Kudosity in the list.

3. Click View/Edit → Settings → OAuth Settings → Consumer Key and Secret.

4. Authenticate if prompted — Salesforce may send a verification code to your email.

5. Copy the Consumer Key.

Save Key and Connect

1. Return to the Kudosity setup screen.

2. Paste the Consumer Key into the field.

3. Click Save Key & Connect.

4. You will be redirected to a Salesforce OAuth consent page — click Allow.

5. You will be redirected back and Live Responses / Reporting will show CONNECTED.

Troubleshooting ECA Setup

Work through this checklist before inviting users. Each item confirms a different part of the integration path.

• The Kudosity setup screen shows the API connection as CONNECTED

• Live Responses / Reporting shows CONNECTED

• Kudosity Admin, Kudosity User and Kudosity View Only are assigned according to each person's role

• A test user can open the Messaging and conversation interfaces

• A test SMS to an approved number arrives on the handset

• The Salesforce message record moves from Sent to Delivered

• A reply from the handset appears in the Salesforce conversation

• A tracked link click is recorded in Link Hits

• A two- or three-recipient test campaign completes successfully

Do not skip the reply test. A successful outbound send only proves the API connection works. The delivery, reply and link-hit tests are what prove the External Client App, Salesforce platform events and record-processing path are all working end to end.

Recipient Object — define your recipient object by typing the object name, for example Lead, Contact, Campaign, or Opportunity.

Field for Mobile Number — select the field within your object that holds the mobile number.

Choose List View / Campaign — refine targeting by selecting a list view or campaign. Views can be filtered to create segmented lists.

Review Message Recipients — click the recipient count to preview who will receive the message, including name, mobile number, and country.

From (Sender ID) — select from your verified senders. Your admin may have pre-assigned a default Sender ID to your user. Use a virtual number or short code if you want to receive replies — alphanumeric senders cannot receive replies.

Campaign Name — enter a name to report against later.

Message Template — save messages as reusable templates. Begin typing a message and the Save button will appear. Select saved templates from the dropdown.

Merge Field — personalise messages by merging any field from your selected object, for example First Name.

Tracked Link URL — add a URL to automatically generate a tracked short link. The {tracked-link} variable is inserted into your message. Link hits are recorded in the Link Hits tab and on Conversation records, and can trigger Salesforce Flows.

Message — write your SMS here. The character counter calculates UTF-8 lengths automatically. Standard messages are 160 characters; UTF-8 is 70 characters. Maximum 4 parts.

Country Field — optional. Helps format numbers correctly for international delivery.

Undeliverable Message Validity — set a validity period. After this time, undelivered messages will stop retrying.

Validity availability varies by carrier — contact support to confirm for your destination.

Schedule — set a future send date and time. Scheduled messages appear in the Sent tab.

Confirmation — before sending, a confirmation dialog shows the send date/time and recipient count. Double-check and click Send.

View all sent and scheduled messages in the Sent tab. Data populates as Kudosity returns live delivery information.

To cancel a scheduled message: select it from the Sent tab → click Cancel SMS → confirm cancellation.

The Received tab shows all inbound replies including emoji responses.

The Link Hits tab shows recipients who clicked a tracked link, including the original and shortened URLs.