Custom API

Select the custom API you want to execute.

Route

Select the route for the custom API. (.e.g., /notifications/contractTermination)

Method

Select the configured method of the custom API (e.g., GET, POST).

Request Body

Enter the request body for the API call if required.

Query Params

Add optional parameters to send with the request. (.e.g., status=active)

To add multiple parameters, click Add. To remove all parameters, click Remove All.

Entry Criteria

Entry Criteria

Specify fields and their values:

• Field: Select the field you want to set as the condition criterion. It lists fields and constants associated with the object you have selected at the time of workflow creation.
• Operator: Select the logical operator from the list. This operator defines the relationship between the field and its value.
• Value: You can either manually enter the field data or use dynamic values based on variables or formulas. Place the cursor in the text box, and the system will suggest options based on the field's data type.
  • Manual Entry: Enter the value directly in the text box. Supported data types include standard types as well as more complex types like Lookup, Owner, Currency, and Multi-Picklist.Lookup: {"Id":"28c22389-9441-4332-a6db-b4628e4b6cb0","Name":"ABC Corp"} Owner: {"Id":"28c22389-9441-4332-a6db-b4628e4b6cb0","Name":"Admin","OwnerType":"User"} Currency: {"Value":12000} Multi Picklist: ["Large Enterprise","Consumers & Vendors"]
  • Dynamic Entry: Choose variables, formulas, or context records to automatically populate the value. The system will evaluate and apply the generated value to the corresponding field. To learn more about creating variable and formulas within a workflow, see Creating Workflows.
    • Owner Field Configuration: Select the RecordOwner option in the Field text box to open a dropdown with User and User Group options for setting ownership details.
    • Lookup Field Configuration: Type in the Field text box to see relevant results under Lookups, along with options like Variable and Formula.

To add more conditions, click Add Criteria. To remove all conditions, click Remove All.

Switch to New Entry Criteria

Filter Expression

By default, the application applies AND logic to all criteria. You can adjust this to create more complex logical expressions if needed. You can customize your logic using parentheses, AND, OR, and NOT.

For example, if you enter “(1 AND 2 AND 3) OR 4”, the system will evaluate whether all three of the first conditions are true, or if the fourth condition is true.

Specifies the variable that stores the API response for use in later workflow activities.

• For new activities or when no output value is defined, this field is hidden. The system automatically uses the Reference Name as the output variable.

• If an output value already exists, the field is visible but read-only. The system continues to use the existing Activity Output value, which you can view but not edit.

Select this checkbox if the variable contains a collection of values, such as a list or array. Leave it unchecked if the variable holds a single value.

This helps the system determine how to process the data, especially during transformations or when passing data between activities.

Use this dropdown to specify the format or structure of the variable's data. Currently, only JSON is supported.

Ensures the system interprets and processes the data correctly based on its structure.