Perform an API call in Salesforce by specifying the endpoint URL, selecting the desired HTTP method, including request headers (in JSON format), providing an optional request body, and optionally attaching a file.
Application
Salesforce
Inputs (what you have)
Name | Description | Data Type | Required? | Example |
Endpoint | The URL of the API endpoint to access | Text (Long) | Yes | |
Method | The HTTP method to be used for the request | Predefined Choice List | Yes | GET |
Request headers | Additional headers to include in the request in JSON format | Text (Long) | No | {"Content-Type": "application/json"} |
Request body | The data to be included in the request body | Text (Long) | No | {"name": "John", "age": 25} |
File | A file to be included in the request | File | No | example.png |
Note: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data library section. These variables in the Data library section are the outputs of previous Wrk Actions in the Wrkflow.
Outputs (what you get)
Name | Description | Data Type | Required? | Example |
Response status code | The HTTP status code returned in the response | Integer | Yes | 200 |
Response headers | Additional information provided in the response headers | Text (Long) | No | Content-Type: application/json |
Response body | The main content of the response | Text (Long) | No | {"message": "Success"} |
Downloaded file | A file that is downloaded as part of the response | File | No | example.pdf |
Note: The "Fields to Capture" input feature can be used to create new outputs for the Wrk Action with the value of the corresponding key name in the first-level JSON output of the Wrk Action.
Example: If the "Response Body" output is equal to {"message": "Success"} Then you are able to add a "Fields to capture" input with the name "message" that will add an output to the Wrk Action called "message" which will have the value "Success"
Outcomes
Name | Description |
Success | This status is selected in the event of that the API call returns with a status between 200-399 |
Unsuccessful | This status is selected in the event of that the API call returns with a status of 400+ |
Impossible to Complete | This status is selected in the event of the following scenario:
|
Requirements
N/A
Configure Salesforce External Client App
In your Salesforce account, go to Setup, then navigate to Apps
Under Apps, go to the External Client Apps Manager
Create a new External Client App.
Fill in basic information and enable OAuth settings
Configure OAuth Settings
Enable OAuth
Set Callback URL
Even for client credentials, Salesforce may require it
Example:
https://localhost/callback
Add all required OAuth Scopes, it must have
api(Manager user data via APIs)
Under Flow Enablement, check Enable Client Credentials Flow
Click Create
Edit OAuth Policies
Scroll to OAuth Flows and External Client App Enhancements
Check Enable Client Credentials Flow
Select the Salesforce user that API requests should run as.
Save the policy changes.
Note: If the Run As user is not enabled, Salesforce will reject token requests even if the Client ID and Client Secret are correct.
Obtain Credentials
After the External Client App is created, get the following info and use them to configure the External Client App credential on the Wrk platform
Consumer Key (Client ID).
Consumer Secret (Client Secret).
Instance URL