Recipes and Connections

Recipe is automated workflow that defines how data moves between different applications and systems.

Every Recipe begins with a Trigger, which determines the event that starts the workflow. When triggered, the recipe executes one or more Actions, such as creating a contact in Salesforce or sending a welcome email. Recipes use Connectors to integrate with various apps, enabling smooth data exchange across systems.

Recipes support both simple and complex workflows with features such as:

• Conditional logic for decision-making.

• Loops for processing datasets.

• Error handling for managing exceptions

Recipe are set to public or private visibility. Public Recipes are accessible to all Integration Hub users, allowing them to view and clone them.

User Persona: Administrator

The Key benefits of Recipes are:

• Pre-Configured Workflows: Automate tasks with ready-to-use templates.

• Customizable: Easily adapt workflows to fit specific needs.

• Trigger-Based: Start actions based on defined events.

• Cross-App Integration: Seamlessly connect apps like CRM, project management, and messaging tools.

Connections

A connection is the instance or configuration of a connector typically where you provide credentials, endpoints, or authentication details. A Connection is a secure, configured link between an integration platform (like Integration Hub) and an external system (such as Salesforce, ServiceNow, Slack, or SAP). It allows the platform to authenticate and communicate with that system to send, receive, or update data as part of an automated workflow.

Users need the Create Connections privilege to create connections.

Add connection

To add a Connection, perform the following steps:

1. Select the Project.

2. Click the Create arrow, then select Connection.

   The New Connection page is displayed.

   

   Figure: New Connection Page

3. Search bar allows users to search for a specific application by name. Type the name of the desired application to filter results.

   

   Figure: Jira application

4. Click Jira application to connect.

   

   Figure: Connect to Jira

5. Enter all the mandatory fields. Select the appropriate authentication method.

   Field Description

   Field	Description
   Connection Name*	Enter a unique Connection Name for connection. This name can be reused in other Recipes.
   Location*	Select the appropriate Location from the dropdown menu.
   Connection type*	Choose Cloud when connecting to a cloud-based instance.
   Auth type*	Select the Authentication type for Jira connection. The available options include: Basic: Uses a username and password (or encoded string) for simple, direct authentication. API Token: Uses a unique token key to authenticate API requests without exposing a password. OAuth 2.0: A secure, token-based authorization framework that allows limited access without sharing credentials. Personal Access Token: A user-generated token that replaces a password for accessing APIs securely, often with scoped permissions. Note OAuth 2.0 is supported for Jira Cloud subscriptions but not for Jira Server or Jira Data center
   Host name*	Enter the Host name of the respective Jira application. Example:
   Email*	Enter the Email address associated with your Jira account.
   API token*	Enter the API token generated from your Jira account for authentication.
   Advance settings	Configure Advance settings as needed for your connection.
   Personal access token*	Enter the Personal Access Token if applicable for authentication.

6. In the Host Name field, enter the HTTPS subdomain for your Jira instance

7. Click Connect button to establish the connection.

Recipe

A Recipe is an automation workflow that connects applications and executes tasks based on triggers and actions. Before configuring a Recipe, define the workflow objectives, identify the required apps, and determine the trigger event that initiates the automation.

To create a new Recipe in the Project, perform the following steps:

1. Select the Project.

2. Click Create, then select Recipe.

   The My New Recipe page is displayed.
   

   Figure: Create Recipe

3. Enter Name, select Location (The project or folder where you want to store your recipe) and Pick a starting point to create a Recipe.
   

   Figure: My new recipe
   Field Description

   Field	Description
   Name	Specifies the name of the page. The name chosen is displayed in the project page.
   Location*	Select the Location for the Recipe
   Pick a starting point*	To set up Recipe, select a starting point

   Recipe steps define the core logic of a recipe. They allow you to create, update, or search within a target app. Steps also include control flow statements, such as IF conditions or repeating actions using Repeat steps. Utility steps support error handling, stopping jobs, invoking reusable logic, and transforming data.

   If you choose to build your Recipe manually, you can select from multiple starting points. The available startti

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

• Run on a schedule: Use the Scheduler - New recurring event trigger to run your recipe at specified intervals, such as weekly. You can also use cron expressions to create custom schedules.

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

• Manage other recipes: Use RecipeOps to monitor and manage other recipes, jobs.

• Build a recipe function: Create a Recipe function using the Recipe function - New call for function trigger.

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

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

4. Click Start building to open your new Recipe in the Recipe editor.

   When you start building a Recipe, the first step is establishing a connection between the platform and an app. Each Connection is associated with one instance of the app, such as a user account, and can be re-used across recipes.

5. Select Trigger from an app to start building the Recipe.

6. In the Recipe editor:

   1. Select App as New API Request. On selection of APP, the Trigger initiates the Recipe when a real time API call is received.

      

      Figure: Trigger: App: New API Request

   2. Navigate to Setup tab and enter all the required details.

      

      Figure: Trigger: Setup page

   3. After defining the Trigger step, you can use the Actions steps to build the logic of the Recipe. Each Action block performs a specific function in response to the incoming request.

      

      Figure: Actions

      The following are the Actions steps that help you control the workflow logic:

      Action	Description
      Action in app	Performs a task in a connected application, such as creating or retrieving data.
      Recipe function	Executes a reusable block of logic defined in another recipe or callable action.
      If condition	Adds conditional logic to control flow based on dynamic data or expressions.
      Repeat for each	Loops through a list of items and performs the defined actions for each item.
      Repeat while	Repeats actions while a specific condition is true
      Stop job	Terminates the recipe execution when certain criteria are met.
      Handle errors	Adds custom error handling steps for managing failures or unexpected responses.

   4. Select Action in app and Get Employee Details through HTTP connector. Action sends a request to an external HTTP endpoint,

      waits for a response before continuing, and used to collect input needed for the BambooHR action.

   5. Get employee details from Bamboo in Bamboo HR. Action connects to BambooHR application and uses data from the HTTP response to fetch specific employee information.

   6. The output response sends the fetched employee details as the final API response. This is the endpoint response returned to the client/system that triggered the API.

      

      Figure: Recipe

   7. Click Save to save the Recipe.

To modify the Recipes, perform the following steps:

1. Navigate to Integration Hub > Projects.

   The Projects List page is displayed.

   

   Figure: Projects page

2. Click any existing Project hyperlink. The Recipes list is displayed.

   

   Figure: Projects - Assets

3. Select the existing Recipe to view the details.

Recipe Details:

1. In the Recipe tab, you can see the Recipe workflow.

   

   Figure: Recipe details

   This Recipe retrieves employee details from BambooHR using a real-time API request.

   1. Step 1: New API Request (Real-time)

      1. This step activates the Recipe when it receives a real-time API call.

      2. The Trigger expects input in JSON format.

      3. You can configure the API request and response parameters.

      4. Use the right-side setup panel to define optional fields, add request headers, and provide sample payloads.

2. Click Edit to edit the Recipe.

   The Edit Recipe details page is displayed.

   

   Figure: Edit Recipe

3. You can edit the details of the Recipe steps Trigger and Actions.

   

   Figure: Edit Trigger details

   

   Figure: Edit Actions details

4. Once the Recipe is created, click Save.

5. Go to Test Recipe tab to run the Recipe. The Recipe runs successfully

Jobs:

A Job represents a single execution of a recipe it runs each time the Recipe is triggered (by an event, schedule, or manual/API call). The Job processes the entire flow of actions defined in the recipe using the input data at that moment.

The Jobs are essential for:

• Monitoring: See when and how often a recipe ran.

• Debugging: Identify the point of failure using logs and error messages.

• Re-running: Retry a job using the same input.

• Auditing: View historical records of recipe executions

Figure: Jobs

Connections:

Connections allow your Recipe to securely connect and interact with third-party applications (like BambooHR, Salesforce, ServiceNow, etc.) using authentication credentials such as API keys, OAuth tokens, or login credentials.

The Connections tab is used to:

• Establish secure integrations with external services (e.g., BambooHR).

• Reuse connections across multiple recipes.

• Manage and edit authentication credentials.

• Monitor the connection status (Active/Inactive).

Figure: Connections

To create Bamboo HR account, perform the following steps:

1. Navigate to Integration Hub > Recipes > Connections. The Connections page is displayed.

2. The two types of Connections are:

   1. My BambooHR account":

      This is a BambooHR Connector and Fetch employee details securely using the BambooHR API token and subdomain.

      Field Description:

      Field	Description
      Connection Name	A user-defined label (e.g., My BambooHR account) to identify the integration.
      API Token	A secure token (hidden) used to authenticate requests to the BambooHR AP
      Sub domain	Your organization's unique BambooHR subdomain (e.g., symphonysummit.bamboohr.com).
      Disconnection Button	Click to remove this connection from the recipe.
      Connection Status	Shows the connection is currently Active (green dot).
      Connection Established Stage	Shows when the connection was last set up or refreshed.
      Switch button	Allows users to change to another saved connection.
      Edit/Refresh	Click Edit connection or refresh page to update the credentials or see changes.

   2. bambooHR: RestAPI

      This connection enables your Workato recipe to interact with BambooHR’s REST API using basic HTTP authentication. This connection enables your recipe to interact with BambooHR’s REST API using basic HTTP authentication.

Versions:

The Versions tab in Workato allows you to manage, track, and restore previous changes made to a recipe over time. This is especially helpful for auditing, rollback, and collaborative development.

Figure: Versions

Test cases:

A test case includes a set of simulated data and validation checks for specific steps in a Recipe. You can create multiple test cases for a Recipe to validate its behavior.

Each test case specifies the following:

• The steps that use mock data and the corresponding simulated values.

• The expected output data for selected steps and the conditions to validate that data.

You can also assign a unique name and description to each test case to indicate its purpose.

Figure: Test cases

Settings:

The Settings tab in the recipe configuration allows users to manage operational preferences, audit activity, and define system behavior for concurrent jobs.

General:

The General section provides access to key insights such as usage metrics, dependencies, and activity audits to help monitor and manage the recipe effectively.

• Usage metrics:

  Track and view the operational statistics and usage data of the recipe over time. Click View usage to open the metrics dashboard.

• Dependencies:

  Identify dependencies between this recipe and other assets. Click View dependencies to see what this recipe uses and what depends on it.

• Activity audit:

  Audit trail for user activities. Click View audit log to check who did what and when.

• Max Concurrency:

  Configures the number of parallel job executions to optimize performance for high-volume processing.

   Figure: Settings

To view the Recipes and Custom connectors, perform the following steps:

1. Navigate to Integration Hub > Recipes.

   The Community library page displays the Recipes and Custom connectors tabs.

   
   Figure: Community library Homepage