3.7.6.1 API Data Source- Salesforce

Starting from version 3.0.0 and above, Quilliup supports integration with Salesforce via an OAuth2 API connection.

⚠️ Important:
The initial token creation must be performed while Quilliup is running in HTTPS mode.
Once the token has been successfully generated, you can continue to use Quilliup in HTTP mode, and the Salesforce connection will remain valid.

Accessing the Data Source Configuration

1. Log in to the Quilliup UI.

2. Navigate to Quality Gate.

3. From the left-hand menu, go to Settings → Data Sources → API.

4. Click Add Data Source
   

5. Fill the connection details:
   Name Enter a descriptive name for the connection
   
   Type Select API_OAUTH2 from the dropdown list.
   
   
   Auth_URL & Token_URL  These values are defined by Salesforce (generic for all Salesforce users)
   
   Client_ID & Client_Secret Provided by Salesforce when creating the connected app.
   
   Scopes Determines what data is included in the token response — what information will be accessible from the Data Source. there are two common token options:
   api – The token is valid for 5 minutes and must be manually refreshed once it expires.
   api refresh_token – The token automatically refreshes itself when it expires. This is the recommended option for most users.
   
   Client auth method Leave this field empty.
   
   PKCE This is an additional security layer required by Salesforce — make sure to check the box.
   
   
    

6. Click Test Connection

7. A Salesforce authentication URL will appear in the top-right corner 

   
   
   Under the Test Connection button, there is another button “Press to Authenticate Draft” - click it to proceed to Salesforce
   
   

   ⚠️ Important:
   Make sure that in the Salesforce connection, the correct server URL where Quilliup is installed is defined as the "Callback URL" in the Salesforce settings.
    

8. Enter your Salesforce credentials.
   
    

9. Click Allow to approve access and complete the PKCE authorization flow.
   

10. The following screen will appear — click “Return to Grid” to go back to the UI.
    

11. Click “View Token Status” and make sure the token status is Active
    

Connecting a Data Set to a Salesforce Data Source

1. From the left-hand menu, select the desired project.
   

2. Go to Library → Data Sets.

3. Click Add Data Set.

4. Fill in the following fields:
   Name Enter the name of the table
   
   Data Source Name Select the Salesforce connection created in the previous step
   
   
   Description & Tags Optional
   
   Auth password & Auth username Leave these fields empty.
   
   API Define the Salesforce endpoint and query that will return the desired data. This includes both the Salesforce URL and the SQL query. 
   Example : services/data/v61.0/query?q=SELECT Id,Name,Industry FROM Account LIMIT 10
   
   Request Method Depends on the operation performed on the table — usually GET/POST
   
   Type Depends on the response format — Salesforce typically returns a JSONObject
   
   Is SSL Check this box if the API uses SSL for connection.
   
   Is Encode Check this box if the API is not encoded.
   example URL-encoded: SELECT%20Id%2C%20Name%20FROM%20Account%20WHERE%20Name%20%3D%20%27Acme%20Inc%27 
   
   Response Path Define according to the product and response type. For example, if the response type is a JSON object, enter records.
   
   

5. Click Refresh Columns — this will automatically load the columns from the Salesforce table defined in the API.

6. Select the columns you wish to use.
   

   ⚠️ Important:
   If the column type is “Date”, it’s important to change the format to match the format used by Salesforce- 
   including both the order of the year, month, and day, as well as the separators between them (comma, dot, slash, etc.).
   

7. Click Save and Close.

• (Optional) To preview the loaded data, click Sample Data.

• (Optional) To verify your query, click Validate Query — a pop-up window will display the test results to confirm that the query is valid.