Set Up a Data Source on a Flexcard

Configure how to retrieve the data that a Flexcard shows. Pull it directly from Salesforce objects with Omnistudio Data Mappers, Salesforce Object Query Language (SOQL) queries, and Salesforce Object Search Language (SOSL) searches. You can also use an external source with REST methods. For complex business processes, use the Apex remote method or Integration Procedures. If needed, set different data sources for the child and parent Flexcards. Then, choose where to publish the Flexcard.

For optimal flexibility and easier implementation, use an Integration Procedure as a data source to execute multiple actions in a single server call. See Set Up an Integration Procedure Data Source.

If you don’t see a data source, confirm that it’s turned on. See Enable and Disable Data Sources.

Set up the data source when you create a Flexcard or update the existing data source on an existing, inactive Flexcard from the Setup tab. See Configure Flexcard Settings.

This article describes the information required after you select the data source type for the Flexcard.

Note We recommend that when you pull data into the Flexcard through any data source, you impose a low limit on the amount of data you're fetching. After your card is developed and published, you can increase the amount of data you pull.

• Set Up a SOQL Query Data Source
  Configure a data source to use a Salesforce Object Query Language (SOQL) query to search an org's data for specific information. SOQL queries are encrypted so that Flexcards don’t display query information on the client-side.
• Set Up a SOSL Search Data Source
  Construct text-based search queries against the search index with Salesforce Object Search Language (SOSL). By using a single query, you can search text, email, and phone fields for multiple objects to which you have access, including custom objects. SOSL queries are encrypted so the query information isn’t visible on the client side. To enforce field-level security for an SOSL query, navigate to Setup and add the EnableQueryWithFLS Omni Interaction Configuration and set it to true: EnableQueryWithFLS=true
• Set Up an Apex Remote Data Source
  Configure a data source to invoke an Apex class and method that fetch data to populate a Flexcard. Apex remote data sources can run asynchronously, which increases the CPU time but ensures that long-running transactions don’t time out. An Apex remote class is a standard Apex class that implements the VlocityOpenInterface.
• Set Up an Apex REST Data Source
  Configure a data source to use an Apex REST call to retrieve data to populate fields on a Flexcard with the GET method. Use the POST method to send back data to the server.
• Set Up an Omnistudio Data Mapper Data Source
  Configure a Data Mapper data source to fetch data from a Data Mapper Extract. Field-level security is fully supported.
• Set Up a REST Data Source
  Configure a REST data source by retrieving or sending data through a public API, such as weather data from a weather API based on a policyholder's ZIP code. You can also use named credentials to authenticate Apex callouts that specify the URL of a callout endpoint and its required authentication parameters in one definition.
• Set Up an Integration Procedure Data Source
  Configure a data source to use an Integration Procedure that executes multiple actions in a single server call. For example, you want your customer service agents to view the weather forecast of policyholders when they’re on a call. To do so, use an Integration Procedure with a Data Mapper Extract that returns an account's ZIP code. Then, use a REST API call that gets the current forecast for the account's region based on the ZIP code.
• Set Up a Streaming API Data Source
  The streaming API method uses push technology, which is a publish and subscribe model that transfers information initiated from a server to the client based on criteria that you define. It has a persistent connection that continuously delivers new data as it becomes available, rather than using client polling. By using streaming API, you reduce the number of API calls and thus improve performance.
• Set Up a Custom Data Source
  Directly embed custom JSON data into Flexcard without depending on an external data source. Configure this custom data to test with temporary static data, such as when waiting for API access or for rapid concept testing.
• Set Up an Autolaunched Flow Data Source (Pilot)
  Configure a data source to use a new or existing autolaunched flow in your Flexcard.

Set Up a SOQL Query Data Source

Configure a data source to use a Salesforce Object Query Language (SOQL) query to search an org's data for specific information. SOQL queries are encrypted so that Flexcards don’t display query information on the client-side.

Note

When you map fields, only fields in the field picker that have non-null values for the specific record in the test query are visible. Use a test record that you know has non-null values for all the fields to map. Or use custom fields if the test record doesn't have such fields.

1. To enforce field-level security for an SOQL query:
   1. From Setup, select and open Omni Interaction Configuration.
   2. Click New Omni Interaction Configuration.
   3. For Name and Label, enter EnableQueryWithFLS. For Value, enter true.
   4. Save your changes.

   When the EnableQueryWithFLS setting is enabled, Flexcards display only the fields that the user has permission to view. Any fields the user doesn't have access to are hidden.

   

   Important During the week of February 2, 2026, Salesforce enables the EnableQueryWithFLS setting by default to enhance org security. Review and prepare your configuration for a seamless transition and to prevent potential service interruptions. See Security Checks for Omnistudio.
2. Enter an SOQL query and other options as needed.
   For example, get up to 10 fields from the Contact object when there’s an existing email address by using this query:

   SELECT Id, Name, Email, Phone, Title FROM Contact WHERE Email != Null LIMIT 10

Set Up a SOSL Search Data Source

Construct text-based search queries against the search index with Salesforce Object Search Language (SOSL). By using a single query, you can search text, email, and phone fields for multiple objects to which you have access, including custom objects. SOSL queries are encrypted so the query information isn’t visible on the client side. To enforce field-level security for an SOSL query, navigate to Setup and add the EnableQueryWithFLS Omni Interaction Configuration and set it to true: EnableQueryWithFLS=true

Important During the week of February 2, 2026, Salesforce enables the EnableQueryWithFLS setting by default to enhance org security. Review and prepare your configuration for a seamless transition and to prevent potential service interruptions. See Security Checks for Omnistudio.

1. Enter the search term.
2. Select the fields to search from.
3. Select at least one sObject and one field to search.
4. If needed, enter a limit of the maximum number of rows to return.
5. Enter other search information as needed.

Set Up an Apex REST Data Source

Configure a data source to use an Apex REST call to retrieve data to populate fields on a Flexcard with the GET method. Use the POST method to send back data to the server.

Note

For optimal flexibility and easier implementation, use an Integration Procedure as a data source to execute multiple actions in a single-server call. See Set Up an Integration Procedure Data Source.

1. Enter the endpoint URL such as /services/apexrest/{namespace}/CardTestApexRestResource/{recordId}.
   This example shows a REST class:

   @RestResource(urlMapping='/v1/typeahead/*') 
   
   global with sharing class TypeaheadApexRest {
       @HttpGet
       global static void doGet()
       {
           RestResponse res = RestContext.response;
           res.responseBody =blob.valueOf('["amazon","airbnb","amazon prime","american airlines","american express","apple","aol mail","at\u0026t","apple store","adele"]');
       }
       
       @HttpPost
       global static void doPost()
       {
           RestRequest req = RestContext.request;
           RestResponse res = RestContext.response;
           
           res.responseBody = blob.valueOf(JSON.serialize(new Map<String, Object>{'someResponse' => 'Post is done'}));
       }
   }

2. Select a method type:
   • GET: Request data based on the parameters of the URL.
   • POST: Send JSON data.
3. For the POST method, enter the JSON data to send in the JSON Payload field.
   You can use context variables to pass inherited values with either method.
4. Enter other Apex REST data source information as needed.

Set Up an Autolaunched Flow Data Source (Pilot)

Configure a data source to use a new or existing autolaunched flow in your Flexcard.

Before You Begin

Note Autolaunched flows in Flexcards is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.

• Contact Agentforce to enable this pilot feature in your org.
• Make sure that you've enabled Enhanced Runtime Performance in Omnistudio Settings. See Enable Enhanced Runtime Performance of Components.
• Make sure you don't use a flow that has the Picklist, Multi-Select Picklist, or Apex-Defined data types.

You can use an autolaunched flow as a data source, or add it via an Action input element.

1. In the Flexcard's Setup panel, navigate to the Data Source section.
2. In the Data Source Types dropdown, select Autolaunched Flow.
3. In the Autolaunched Flows field, search for the flow you want to use as a data source and select it.
4. In the Import section, click Import.
5. In the resulting window, select the keys you want to include in your inputs and enter their values.
6. To add an autolaunched flow as an action, add an Action input element to your designer.
7. In the Element Details panel, expand the Action section.
8. Select Data as the action type.
9. In the Data Source Types dropdown, select Autolaunched Flow.
10. In the Input Map section, select Import.
11. In the resulting window, select the keys you want to include in your inputs and enter their values.