Add API Node
Updated
The Add API node enables workflows to connect with external systems to retrieve data and execute actions. For example, you can integrate with external CRM platforms or fetch customer information from client data sources. This allows workflows to extend beyond Sprinklr and interact with third-party systems in real time.
When you configure an API, the node automatically validates the API response by checking for an HTTP status code of 200. Based on the result, the workflow can follow either a Success or Failure execution path, enabling you to handle successful responses and technical errors differently.
How It Works
When the workflow reaches this node, it calls the configured API using the mapped input parameters. Depending on the selected API execution mode, the workflow either pauses and waits for the response before continuing or moves on immediately without waiting.
Once a response is received (or the request times out), the node evaluates the HTTPS status code to determine whether the call succeeded, then routes the workflow down the corresponding Success or Failure path, provided an Exception Variable has been configured.
The API response is available in the following formats:
Adapted API Response Variable: Stores the response in a structured format for easier use within subsequent workflow steps.
RAW API Response Variable: Stores the complete unprocessed API response when access to the original payload is required.
Supported Fields
Field | Description |
Name | Enter a unique and descriptive name that identifies the purpose of the node within the Integration Flow. |
API | Select the API that you want to invoke from the available integration extensions. |
Input | Define the data that is passed to the selected API during execution. |
API Input | Select the API input parameters that must be provided for the request. |
Parameter to Send to API | Map each API input parameter to a workflow variable or a static value that will be sent as part of the API request. |
Output | Map the API response parameters to workflow variables for use in subsequent nodes. |
API Execution Mode | Select Wait for API Response to pause workflow execution until a response is received, or Proceed Without Waiting to continue to the next node immediately after the request is sent. |
Threshold for API Timeout (in seconds) | Specify the maximum amount of time the workflow waits for an API response before the request times out and is treated as a failure. |
Exception Variable | Specify a variable to capture errors resulting from a failed API call. When configured, the node can route execution through the Failure path when an API error occurs. |
Adapted API Response Variable | Stores the API response in a structured and formatted representation that can be easily referenced within the workflow. |
RAW API Response Variable | Stores the complete unprocessed API response in its original format. |
Choosing an Execution Mode
The two API execution modes serve different purposes depending on how critical the API response is to the rest of the workflow:
Wait for API Response is the right choice when subsequent nodes depend on data returned by the API, for example, pulling customer details that need to be displayed or acted on immediately.
Proceed Without Waiting is useful for fire-and-forget actions, such as logging an event or triggering a downstream system update, where the workflow doesn't need to pause for confirmation before moving on.
Example Use Case
When a customer calls support, the Add API node can use their phone number to query the brand's CRM. It pulls up their information, such as name, plan, or issue history, so the support team can offer faster, more personalized assistance without switching between systems manually.
Best Practices
Configure an Exception Variable: Always configure an Exception Variable in production workflows. Without an exception variable, failed API calls cannot be distinguished from successful executions or routed through a dedicated failure path.
Set an Appropriate Timeout Threshold: Configure the timeout value based on the expected response time of the API. A timeout that is too short may cause valid requests to fail, while a timeout that is too long can delay workflow execution.
Select the Right Execution Mode: Use Wait for API Response when subsequent workflow steps depend on the API response. Use Proceed Without Waiting for actions that do not require an immediate response.
Use the Appropriate Response Variable: Use the Adapted API Response Variable for most workflow scenarios, as it provides a structured representation of the response. Use the RAW API Response Variable only when the complete unprocessed response is required.
Verify Required Input Parameters: Review all mandatory input parameters before saving the node. Missing required inputs can prevent the API request from being executed successfully.