Recipe Builder is an Integration Platform as a Service (iPaaS) environment that allows administrators to automate triggers and actions with external systems and GUIDEcx. This allows for bi-directional syncing via APIs and elimination of double-entry of the same updates in both systems.

Recipe Builder merges the functionality of an enterprise-grade workflow automation platform with the user-friendly experience commonly found in consumer apps, empowering business and IT users to swiftly construct automations within GUIDEcx.

Only Admins can access and manage Recipe Builder.

Recipes are a set of automated steps built by users that can span multiple apps, such as creating projects in GUIDEcx when a Salesforce Opportunity is Closed-Won. Each Recipe comprises of a trigger and one or more actions that are carried out when a trigger event is picked up.

Triggers determine what event Recipe Builder listens for to execute the actions described in a recipe. Trigger events can be set off when an event happens in an app (such as Salesforce, JIRA, or GUIDEcx), when a new line is added in a file, or according to a schedule.

Depending on the available API, Recipe Builder can receive trigger events in real-time, or check for the occurrence of an event periodically by polling the app.

Recipe Steps are instructions for Recipe Builder on what to do when the Trigger is met. Recipes are required to have at least one step. The most basic step for a recipe is in action within an app.

Recipe Builder steps can be actions in an app or a logical step on how to proceed with the recipe.

Every step brings data into a recipe. This data is available to add to later steps as a datapill via the Recipe Data Pane.

Datapills allow you to configure the recipe to utilize data from one system in another system. For example, the following datapills are available for the Trigger New/updated Salesforce Opportunity.

For a recipe to take action within an app, it has to be authorized by the app. This authorization is referred to as a connection. Connections can be used by multiple recipes.

Whenever a trigger event occurs, the steps in the recipe are run. This is called a job. Jobs can either be successful or contain errors, and in the event of an error, subsequent step actions are not carried out.

A record of each job is saved within recipe builder, including details of the steps taken and any responses from the external systems.

Follow these steps to access Recipe Builder:

Recipe Builder's Dashboard provides users with information on job runs and step-by-step details on what data was used as inputs and outputs. This information is beneficial when debugging an integration.

Follow these steps to access the jobs and run details from the Dashboard:

The Recipes page contains your existing recipes and connections. These Assets are organized into projects, which are further broken down into folders. A project can contain multiple recipes and connections.

For example, the following screenshot shows a Project titled Zendesk with 2 Connections, 3 Recipes, and a Folder titled: Old Zendesk Recipes.

Within the Recipes page of recipe builder you're able to view and edit existing recipes, and create new recipes and connections.

The Properties page allows you to create up to 100 properties that can be used in your recipes as a datapill. This can be useful for complex deployment models accross multiple recipes, for example you can have a property that contains an email address used to send notifications to. All of your recipes can then use that value to send emails to the same recipient.

The community contains pre-built integrations from a broader community that can be leveraged to streamline recipe development.

By default, the Community page opens to the recipes tab. At the top of the page are GUIDEcx recommended app. These are pre-built recipes sorted by external application that you can use to connect GUIDEcx to that system.

Follow the steps outlined in Installing Recipes From the Community Library in Recipe Builder to install one of these recipes.

The Custom Connectors section allows you to search community-built connectors. Connectors provide pre-built packages for interacting with the API of integrated systems. These streamline the authentication and automation process even if you are less familiar with code. The connector tool allows you to search for connectors that have been built by the larger community.

Follow these steps to install a connector from the community:

The Connectors page allows you to see and create new connectors. For more information creating a new connector, see Creating a New Connector in Recipe Builder.