Integration Procedures (IP) in Salesforce OmniStudio are used to process, transform, and exchange data between Salesforce, OmniScripts, FlexCards, and external systems. Two very important elements inside an Integration Procedure are Set Values and Response Action.
In this article, we will learn how to use Set Values and Response Action in an Integration Procedure, why they are needed, and how they work together to send clean, structured data to OmniScript or FlexCard.
Why Set Values and Response Action Are Important
- Set Values helps you create or modify data inside the Integration Procedure
- Response Action controls what data is returned to OmniScript or FlexCard
- Together, they help avoid sending unnecessary or unstructured data
- They improve performance, readability, and maintainability
These elements are commonly used in real-time integrations and UI-driven processes.
What Is Set Values in Integration Procedure?
Set Values is used to:
- Create new JSON nodes
- Assign values to variables
- Transform response data
- Prepare output data for OmniScript or FlexCard
Set Values does not fetch data; it only manipulates existing data.
What Is Response Action in Integration Procedure?
Response Action defines:
- What happens at the end of the Integration Procedure
- Which data is sent back to the calling component
- Whether full JSON or selected output is returned
Without a Response Action, data cannot be reliably consumed by OmniScript.
Step 1: Create an Integration Procedure
- Go to OmniStudio → Integration Procedures
- Create or open an Integration Procedure
- Add required steps (DataRaptor, HTTP Action, etc.)
- Save the Integration Procedure
Step 2: Use Set Values in Integration Procedure
Add Set Values Element
- Drag Set Values onto the Integration Procedure canvas
- Place it after the step whose data you want to transform
Configure Set Values
Inside Set Values:
- Define Key (output field name)
- Define Value (source data path or static value)
Example
If your response contains:
response.Account.Name
You can map it as:
- Key: AccountName
- Value: {response.Account.Name}
This creates a clean output node called AccountName.
Why Use Set Values?
- To rename fields
- To combine multiple values
- To remove unnecessary nested JSON
- To prepare data for Response Action
Step 3: Add Response Action in Integration Procedure
Add Response Action
- Drag Response Action to the canvas
- Place it at the end of the Integration Procedure
Configure Response Action
Key configuration options:
- Return Full Data JSON
- True: returns entire response
- False: returns only mapped output
- Send JSON Path
- Specifies which node to send forward
For clean output, keep Return Full Data JSON set to False.
Step 4: Configure Additional Output Response
What Is Additional Output Response?
Additional Output Response allows you to explicitly define what data is returned.
How to Configure
- Enable Additional Output Response
- Map keys from Set Values
- Choose only required fields
Return Only Additional Output
- Set Return Only Additional Output = True
- This ensures only clean, required data is returned
- Recommended for production implementations
Step 5: Preview and Test Integration Procedure
- Go to the Preview tab
- Provide test input parameters
- Click Execute
- Verify output JSON structure
This helps confirm Set Values and Response Action are working correctly.
How OmniScript Uses This Data
In OmniScript:
- Add an Integration Procedure Action
- Pass input using Extra Payload
- Capture response using Response JSON Path
- Use data in:
- Text blocks
- Set Values
- Decisions
- Navigation logic
Best Practices
- Always use Set Values before Response Action
- Avoid returning full JSON unless required
- Use meaningful key names
- Enable Return Only Additional Output
- Test IP independently before using in OmniScript
- Keep output lightweight and structured
Common Mistakes to Avoid
- Skipping Response Action
- Returning unnecessary full JSON
- Incorrect JSON path mapping
- Not testing with real input values
- Overloading Integration Procedure with logic
Conclusion
Set Values and Response Action are essential building blocks in Integration Procedures. Set Values prepares and structures the data, while Response Action ensures only the required data is sent back to OmniScript or FlexCard.
Mastering these two elements helps you build clean, efficient, and scalable OmniStudio integrations.