The Try API feature in Cobalt allows users to simulate event or workflow execution, providing a convenient way to test workflows and validate the behavior of associated actions.

The Try API feature can be utilized in both Production and Test environments.

Events selected through the Try API interface can serve as triggers within workflows. The payload associated with the selected event is loaded by default within the Try API interface and users can make necessary modifications to it before firing the event.

Using Try API, you can simulate execution for workflows with Event based triggers or Workflows API triggers.

Pre-Condition

Before utilizing the Try API feature, ensure that the Application is connected for the Linked Account and configured properly.

  • Navigate to the Application for which you want to create and test a workflow.
  • Create a workflow and add an Event or Workflow API depending on your use-case in the Start Node, along with associated actions. Publish the workflow to make it available for execution.

Learn more about how to create workflows here.

  • Enable the workflow for a Linked Account after making a successful connection through authenticating.

Execution

To fire an event in the Try API section, follow these steps:

  • Navigate to the Try API section in Cobalt.
  • You will have 2 options to perform execution depending on the trigger added:

Expected Result

Upon firing or executing, it will be logged within the Cobalt system. You can check the logs by navigating to Logs section in Cobalt.