Getting started with the Joyous Salesforce app
The Joyous Salesforce app connects your Salesforce org to Joyous, enabling you to automatically trigger employee or customer feedback campaigns based on record changes in Salesforce.
Getting Started with the Joyous Salesforce App
Once configured, you can use Salesforce Flow Builder to send personalised Joyous feedback requests by email or SMS — triggered by any record event, such as a case closing, an opportunity stage changing, or an employee record being updated. Responses are collected and managed in Joyous.
The package includes:
- Flow invocable actions — trigger email or SMS feedback requests from any Record-Triggered Flow
- Feedback button components (LWCs)— add a one-click feedback button directly to any Salesforce record page
Prerequisites
- A Joyous account with at least one active triggered campaign
- Salesforce Enterprise, Unlimited, Performance, or Developer edition
- Salesforce System Administrator access
Existing Joyous customers: To request a sandbox Joyous account for testing, email
support@bejoyous.ai.
1. Install the Package
Install the Joyous package into your Salesforce org using the AppExchange listing. Choose Install for Admins Only when prompted.
2. Assign the Joyous Administrator Permission Set
Any Salesforce administrator who needs to configure the integration or build Flows using Joyous actions must be assigned the Joyous Administrator permission set.
In Salesforce, go to Setup → Permission Sets → Joyous Administrator → Manage Assignments and add the relevant users.
End users who trigger Flows do not need this permission set — Flows execute the Joyous actions independently of the triggering user's permissions.
3. Configure the Integration
Open the Joyous Setup page from the App Launcher (search for "Joyous") and enter the following:
API Key
In Joyous, go to Settings → Integrations to create or copy an API key. You will need Joyous administrator access to reach this page. Paste the key into the API Key field. The key is stored securely and will not be displayed again after saving.
Org ID and Region
In Joyous, open any triggered campaign and go to its settings page. The Org ID and Region values are shown under the Timing section. Copy each value and paste it into the corresponding field on the Joyous Setup page.
Click Save to store your settings.
4. Build a Flow
- In Salesforce, go to Setup → Flow Builder and create a new Record-Triggered Flow
- Configure your trigger (object, entry conditions, and timing)
- Add an Action element on the Run Asynchronously path
- Search for Joyous — you will see two available actions:
- Joyous Email Feedback Request — sends feedback via email
- Joyous SMS Feedback Request — sends feedback via SMS
- Select the action and fill in the required fields:
| Field | Description |
|---|---|
| Joyous Recurring Campaign Group ID | Found in Joyous on the settings page of your triggered campaign |
| First Name / Last Name | Map from the triggering record or a related contact |
| Email / Mobile | The recipient's contact details |
| Record ID | The Salesforce record ID — used to link feedback back to the record |
| Custom Attribute 1–2 (optional) | Additional data to include with the feedback request |
- Save and activate the Flow
Note: SMS sending requires SMS capability to be enabled on your Joyous account and is not available on all plans.
5. Verify
After triggering your Flow on a real record, go to Setup → Apex Jobs and confirm the Joyous job completed without errors.
LWC Feedback Button Components (Optional)
The package includes Lightning Web Components that can be added directly to record pages to allow users to request feedback with a button click. To configure:
- Open App Builder for the relevant record page
- Add the Joyous Feedback Button component to the page layout
- Create a Joyous Link Config custom metadata record (Setup → Custom Metadata Types → Joyous Link Config → Manage Records) for the object, specifying the campaign group ID, field mappings, and optional button label
The button retrieves a personalised survey link for the record and opens it when clicked.
Troubleshooting
| Symptom | Resolution |
|---|---|
| Joyous actions not appearing in Flow Builder | Confirm the Joyous Administrator permission set is assigned to your user |
| Apex job failing with "API Key missing" | Re-enter your API key on the Joyous Setup page |
| Apex job failing with "Org ID missing" | Confirm the Org ID and Region are saved on the Joyous Setup page |
| Survey link not loading in the feedback button | Confirm be.joyoushq.com appears in Setup → Security → CSP Trusted Sites |