Learn how to build custom workflows and integrate 6clicks processes with other platforms
Table of contents
Overview
The Custom Workflow Builder can be used in collaboration with the 6clicks Developer API to automate common tasks and integrate with 1000s of other platforms.
Fully embedded within 6clicks, and powered by Workato, no additional cost or licensing is required to get started with up to 100,000 tasks per year.
Getting started
Ensure you have the correct permissions e.g. Administrator, and head to the Integrations page and select Custom Workflow Builder > Build.
Please contact your Customer Success Manager if you do not see the item on the Integrations page.
Initially you are onboarded with a 31-day trial account and 10,000 tasks. You can upgrade to the Starter Plan for free at any time by contacting your Customer Success Manager.
Recipes
A recipe is an automated workflow that can span multiple apps. For example, you can create a recipe that monitors for new tasks in 6clicks and then sends a message to Slack.
Every recipe includes a trigger and one or more actions, which are executed when a trigger event occurs.
To create a recipe, head to Assets and click Create in the top right corner, then select Recipe.
Here you can set up the following.
- Name
- Location - adjust the location if your organization has Hub & Spokes, or select the current tenant you are working in
- Pick a starting point - you can edit this later, but the starting point selects the first trigger for the recipe.
You will then see the screen where you can build the recipe, where the trigger is already selected based on your starting point.
Connections
A connection authorizes a recipe to interact with apps and API like Salesforce, Zendesk, and of course the 6clicks Developer API through triggers and actions.
Connections are reusable, allowing you to use the same connection across multiple recipes.
To create a connection, head to Assets and click Create in the top right corner, then select Connection. You will find the 6clicks Developer API at the top of the list.
You will need to input the below information to create the connection.
- Connection name
- Location
- API Key - use an existing key or generate a new key by following the Developer API article.
- Region - select the 6clicks instance you are hosted in.
Click Connect and this connection will be ready to use.
Hub & Spoke account structure
This section only applies if your organization utilizes the 6clicks Hub & Spoke architecture.
By default, the Hub and its Spokes are each created as separate workspaces within the Custom Workflow Builder.
It is possible to configure the Custom Workflow Builder so that the hub has direct access to the spokes, so that it can more easily share recipes and connections. This utilizes the project system, and may be appropriate for Hub accounts that require tighter administrative control over automations at the Spoke level.
Reach out to your Customer Success Manager if you would like to configure your account in this manner.
Custom Workflow Builder administration
Using the navigation icons near the top of the page, you can perform administrative tasks to further tailor the Custom Workflow Builder to the needs of your organization.
- Custom OAuth profiles
- Environment properties
- Logs
- Lookup tables
- Message templates
- Recipe lifecycle management
Custom OAuth profiles
Custom OAuth profiles allow you to create custom apps on supported connectors. This gives you control over the app's branding, permission scopes, and OAuth profile.
Custom OAuth profiles also enable you to install multiple custom apps onto a single connected workspace. For example, you can install multiple Enterprise Workbots onto a single Slack Workspace, each with its own identity, branding, and scopes.
Learn more about Custom OAuth Profiles
Environment properties
Environment properties enable you to store account-wide recipe configuration parameters. Environment properties appear in all recipes as usable values as a child of the Properties datatree.
Environment-level properties are also known as environment variables or configuration variables. They are useful for complex deployment models across connections and recipes.
Learn more about environment properties
Logs
Logging is an essential tool for auditing, testing, and troubleshooting.
By default, every time one of your recipes runs, detailed logs are stored for the job.
Learn more about auditing, testing, and logging.
Additional information on how to configure data retention for individual recipes can be found here.
Please contact 6clicks if you need to disable data retention within the Custom Workflow Builder and Workato data center globally for your customer account.
Lookup tables
Lookup tables enable recipes to efficiently store, reference, and manage frequently used data using a table of entry rows and value columns, similar to a cross-reference table.
The Lookup tables page enables you to manually create, delete, update, and parse tables.
Lookup tables are often required when polling for data changes, as they allow the previous state of the data to be tracked.
Learn more about lookup tables
Message templates
Message templates enable you to create static templates for commonly used messages, using a dynamic templating language.
Learn more about message templates
Recipe lifecycle management
Recipe Lifecycle Management enables recipes to be shared between teams, particularly in a Hub & Spoke environment, or from Sandbox spokes to production spokes. Recipes can be exported and imported efficiently.
Learn more about recipe lifecycle management
Where is my data stored?
No data is sent to Workato until you opt-in to the Workflow Builder and begin configuring connections and recipes.
The Custom Workflow Builder stores any keys you use to create Connections, along with Recipe logs, within Workato's AWS regional data center.
The region corresponds with your 6clicks instance is as follows:
- app-au.6clicks.io - AWS Australia
- app-au-gov.6clicks.io - AWS Australia
- app-uk.6clicks.io - AWS EU Central
- app-us.6clicks.io - AWS US East
- app-us-gov.6clicks.io - AWS US East
To completely disable log retention within Workato's data center, please contact 6clicks.
6clicks is currently working towards the capability of allowing recipe logs to be stored fully within the 6clicks Azure data center corresponding with this region, ensuring minimal data retention within Workato. We expect this functionality to be available by CY Q2 2025.
Further reading
The Workato documentation contains extensive support on building recipes and connecting to other apps.
6clicks is here to support you with your workflow automation and integrations, including providing sample recipes from our growing library. Please note that we can only support integrations that use the 6clicks Connector.
The 6clicks Connector and Developer API continues to grow. Reach out if an operation you need is not available in the 6clicks Connector.