Recipes and Connectors

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.

Create 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 the Create arrow, 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.

• 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.

Triggers

Triggers determine the events that initiate the execution of actions in a recipe.

Trigger events occur in applications such as Salesforce or Jira when specific actions take place, such as creating a new contact or updating an existing ticket. Trigger also occurs when a new line is added to a file or at scheduled intervals.

Trigger Mechanism

Integration Hub receives trigger events using two mechanisms:

• Real-time triggers: The application sends events immediately when they occur.

• Polling triggers: The system periodically checks the application for new events.

Triggers are categorized based on how they check for and group new events:

• Polling triggers: The system retrieves new events at fixed intervals.

• Real-time triggers: The system processes new events as they occur.

• Batch triggers: The system collects multiple events and processes them together.

• Scheduled triggers: The system executes based on a predefined schedule.

Recipes pick up and queue trigger events in-sequence to process them as recipe jobs. The recipe maintains a cursor and progresses through the trigger event queue synchronously.

The throughput is adjustable based on system requirements. No duplicate jobs occur because Integration Hub records the trigger events it has processed.

Trigger conditions are additional rules that define which trigger events should be selected for processing.

You can specify that only events related to a specific user account must be processed.

• Integration Hub evaluates trigger conditions after retrieving trigger events. For example, Integration Hub retrieves all new Jira issues created in the last five minutes for a specific user account.

• If a recipe uses the New Jira Issue trigger, only issues associated with the specified user are picked up.

• If your recipe is missing expected events, the trigger condition may be the reason.

Connectors

Connectors provide secure access to business applications. Each connector includes authentication methods, triggers, and actions specific to its target app.

The platform offers a wide range of connectors. To view all supported connectors or search by category, visit the app integrations page.

To build a Recipe, first, establish a connection between the platform and an app. Each connection links to a specific app instance, such as a user account, and can be reused in multiple recipes.

Each connection links to a single app instance, such as a user account, and can be reused across recipes.

Who Can Create Connections?

Users need the Create Connections privilege to create connections.

Integration Hub establishes connections using the app's authorization or authentication API through one of the following methods:

• Basic

• API token

• OAuth 2.0

• Personal access token

During this process, Integration Hub receives permission to access data from the app. The granted permissions match those of the user authorizing the connection.

Integration Hub can only access the data that the authorizing user has permission to view or modify.

For example, if a user has view-only access to accounts in Salesforce and creates a Salesforce connection in Integration Hub, the connection will also have view-only access to accounts.

Creating a Dedicated User for Integration Hub

Using a dedicated app user ensures that recipes are not tied to an individual user’s account. If a user leaves the organization, recipes will continue running without interruption.

Additionally, a dedicated user allows administrators to control and limit permissions, reducing security risks. Different apps offer varying levels of control over user roles and permissions.

Using Sandbox Credentials for Development

For development and testing, use sandbox (non-production) credentials to prevent accidental changes to live data. Testing with non-production data ensures safe and accurate recipe development.

Methods to Create Connections

Users can create app connections in Integration Hub using either of the following methods:

• Connection – Set up connections separately before using them in recipes.

• Recipe Editor – Create and configure connections while building a recipe.

Add connection

To add a connection in the recipe editor:

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.

   Field Description

   Field	Description
   Connection Name*	Enter a unique name for your Jira 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 Jira instance.
   Auth type*	Select the authentication type for your Jira connection. The available options include: Basic API Token OAuth 2.0 Personal Access Token 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 additional options as needed for your connection.
   Personal access token*	Enter the personal access token if applicable for authentication.

6. Select the appropriate authentication method.

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

8. Click Connect button to establish the connection.

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