Recipe

Prev Next

A recipe is an automated workflow that executes a series of steps to integrate and process data across multiple applications.

Every recipe has a trigger, which defines the event that starts the workflow. When triggered, the recipe performs one or more actions, such as creating a corresponding contact in Salesforce or sending a welcome email. Recipes use connectors to interact with different apps, ensuring seamless data flow across systems.

A Recipe in Integration Hub is an automated workflow that connects applications, triggers events, processes data, and performs actions across systems. It defines how data flows, when automation should run, and what actions should occur, using a no-code/low-code visual builder.

Prerequisite

You must create a Project to create a Recipe. For more information, refer Projects.

Create Recipe

Creating a Recipe in Integration Hub allows users to automate workflows, connect applications, and define the logic that drives integrations. The process is designed to be intuitive, using a no-code/low-code builder.

To create a recipe, perform the following steps:

  1. Log in to the Application.

  2. Navigate to Integration Hub > User > Projects.

  3. Create a project, for more information refer Projects.

  4. Click Create and select Recipe in the Project.

    Figure: Recipe

  5. Enter the Recipe Name and select other required fields.
    For more information, refer to the following Field Description.

    Figure: New Recipe

    Field Description

    Field

    Description

    Name

    Enter the Recipe name.
    Example: Jira-Apex Recipe

    Location

    Select the project or folder where you plan to store your recipe from the Location drop-down menu

    Pick a starting point

    Select the starting point as from where the recipe must begin its execution when the recipe is initiated. For more information, refer Starting Point.

    Start Building

    Click Start Building to initiate the recipe build process.

Starting Point

If you choose to build your recipe manually, you have several options for the starting point of your recipe:

Pick a Starting Point

  • Trigger from an app: Choose an app and trigger event to start your recipe.

  • Run on a schedule: Use the Scheduler by Workato New recurring event trigger to run your recipe at specified intervals, such as once a week.

  • Trigger from a webhook: Use the Webhooks New event via HTTP webhook trigger to activate your recipe in real-time when webhook events are sent to a generated webhook address.

  • Manage other recipes: Use RecipeOps by Workato to monitor and manage other recipes, jobs, or your Workato account.

  • Build recipe function: Create a recipe function with the Recipe function by Workato New call for function trigger.

  • Build an API endpoint: Use the API platform by Workato New API request trigger to create API-based recipes.

  • Build a Slack bot command: Use the Workbot for Slack New command trigger and Post command reply action to automate Slack interactions.

Configure Recipe

After you click Start Building, you are navigated to the recipe build page where you can configure the recipe.
Configuring a recipe includes the following:

Figure: Recipe

Note

A Recipe will have one Trigger and one or many Actions.

Trigger

A trigger defines the event that initiates a recipe's execution. Every recipe must have a trigger.
Select an App and trigger an event. For more information, refer Trigger.

Example: Prevent duplicate ticket creation and keep Jira in sync

The flow starts automatically whenever: A new Jira issue is created or an existing Jira issue is updated. This is a real-time event trigger, not scheduled.

  • Creates a ticket in Apex 2.0 system (via HTTP) if it doesn’t already exist.

  • Updates the Jira issue with the returned ticket number so it won’t be created again.

As you select the Jira app then the list of Trigger points are displayed.

Figure: Trigger

Select the New/Updated issue from the list to complete the Trigger configuration.

Figure: Trigger

Actions

Define one or more actions to execute when the recipe is triggered.
Click add icon to insert an action step. For more information, refer Actions.

Figure: Add Action step

After you click on the add icon, a list of items are displayed to select condition based on which the recipe must execute.
For more information, refer Recipe Action.
Figure: Actions

IF Condition - Use Case

To use an IF Condition to create ticket on apex2.0 or update the Jira Issue -
Select IF Condition in the Action step and perform as explained in the following steps:

Figure: IF Condition

  1. Select IF condition.

  2. A right panel with Data Field input is displayed, click on the field.

  3. Recipe data window is displayed, search SummitTicketNo API in the Jira New/Updated issue dropdown. Select to insert in the Data Field.

  4. Select Condition value as “is not present”.

Define the condition for true:

  1. Click on the condition “Select an app and action”.

  2. Select HTTP to send request.

Condition logic:

  • If SummitTicketNo is empty or missing proceed to create a ticket

  • If it already exists skip ticket creation

Figure: Connected Apps

Enter the below details in HTTP section on the right panel.

Define the Request

  • Method: POST

  • Request URL: Is Apex 2.0 application URL

  • Request content Type: JSON body

  • Request Body: IM_LogOrUpdateIncident API.

Define the Response

  • Response Content Type: JSON

  • Response Schema: add fields.

Add a step to update ticket.

Figure: Add step

Define the step to update issue with ticket number as below:

Figure: Update Ticket

References

Documentation