If you're new to Patchworks and want to find out more before you get started, take a look through this section for background information and demo videos.
In this section
Patchworks demos
Introduction
This page includes video demonstrations showing different aspects of the Patchworks platform.
Watch our two-minute explainer video for Patchworks!
Integrating 5 Systems in Under 10 Minutes
Our CTO, Conor Barr, demonstrates using our pre-built Blueprints , Connector Builder Postman Importer & no-code/low-code canvas with ready-to-use process flows, how quickly and easily you can cut down on implementation time and get your systems connected.
Connector builder in 5 minutes
Our CEO, Jim Herbert, shows how easy it is to build your own custom connector with the Patchworks connector builder in just 5 minutes!
Cache & flow control in process flows
Our CTO, Conor Barr, demonstrates the power of flow control and cache shapes in Patchworks process flows.
Patchworks bolt-ons
Getting started
If you're new to Patchworks, find out who we are and what we do!
Registration
There are different ways to register for a Patchworks account - learn about them here.
Company setup
View and manage your Patchworks company profile.
Users & roles
Learn how to add and manage Patchworks users for your company.
Marketplace
Find out about the all-new Patchworks marketplace for blueprints, connectors, process flows, custom scripts, and cross-reference lookups.
Blueprints
If you have a specific integration task in mind and want to install everything you need to get the job done, there might be a blueprint for that!
Connectors & instances
Patchworks is all about connections! Everything you need to know about installing and working with connectors can be found here.
Process flows
Everything you need to know about building your own powerful data flows between your business systems, and working with prebuilt flows.
Virtual environments 💥
Run a single process flow in multiple environments by switching out environment-specific components at runtime.
General settings
Find help for Patchworks setup options for system administrators.
Release notes
Stay up to date with what's new in the Patchworks dashboard and our bolt-ons.
Connector builder
Find guidance on using the all-new connector builder to build connectors for systems that aren't available in the Patchworks marketplace.
Custom scripting
Find out how you can write your own field and payload-level scripts to handle complex data manipulation requirements.
Patchworks API
See how to use the Patchworks Inbound API connector for ultimate flexibility in connecting to non-standard systems.
PATCHWORKS MCP 💥
Connect your integration platform directly to an AI assistant.
STOCKR
Understand how you can manage stock levels across multiple Shopify stores in real-time.
What is Patchworks?
Introduction
Patchworks is an Integration Platform as a Service (iPaaS).
Our secure, multi-language, cloud-based platform automates the flow of data between your company’s business-critical systems/applications in a smart, intuitive way.
In today's market, businesses can pick and mix from best-of-breed applications to tackle specific goals...perhaps an eCommerce application for sales order processing; an ERP system for records management; a warehouse management system to maintain inventory and a CRM for relationship management and marketing.
On their own, these applications fulfil their requirements perfectly. However, the key to real strategic advantage is integration - establishing a frictionless exchange of data between all of your applications, smartly.
Video explainer
Watch our two-minute explainer video for Patchworks!
Your centralised systems hub
Historically, many businesses have gone down the API route to integrate systems, building and maintaining direct APIs in-house. This can be a costly exercise, carrying an administrative burden and a potential drain on resources (assuming you have the resources in the first place).
In contrast, Patchworks provides a cost-efficient way to streamline your operations via one centralised platform - your integrations hub, if you will. Using our intuitive , you can add, manage and orchestrate your integrations with complete peace of mind when it comes to security and scalability.
Self-serve integrations with process flows
Patchworks is a powerful no-code/low-code platform with everything you need to add and manage your integrations.
We know that integration requirements are often highly complex and a real challenge for customers, but we don't think the solution should be. A huge amount of thought has gone into making our no-code/low-code dashboard as smart and user-friendly as possible.
Using click-and-drop with automated and an impressive library of prebuilt (in the ) and blueprints (from the ), you can create powerful data flows in a matter of minutes. You can adjust default field mappings and transformations as needed, trigger syncs, watch syncs run in real-time, view historical data, and troubleshoot issues - all without a single line of code.
Virtual environments
Virtual environments are a great way for enterprise organisations to manage large-scale sync requirements with minimal process flows and no replication of effort.
A is a collection of overrides (known as ) that can be applied when a 'master' process flow runs, so the specific requirements for each environment can be met without needing to duplicate flows.
Connector builder
With Patchworks, you can configure and connect any of our prebuilt in .
But what if we don't have a prebuilt for an application that you need to sync? Perhaps you have a bespoke, in-house system, or maybe you need to integrate an application that's completely outside of the eCommerce arena. No problem - the Patchworks is your new best friend!
If you have technical knowledge of APIs and working with data structures, you can use the to integrate any application with REST or SOAP APIs.
Developer hub
Speaking of technical expertise...
'Out of the box', Patchworks includes everything you need to manipulate and then exchange data securely between different third-party applications, securely and intuitively. However, for users with in-house development expertise and more complex requirements, advanced tools are available that you can use to take your integrations to the next level:
Use the to build against Patchworks from third-party systems and interact with your Patchworks process flows or services.
can be used at the field level (to build highly complex transformations for mapping individual fields) and at the payload level, so you can manipulate an entire payload before it is sent to the next step in your process flow.
Certifications
Patchworks is proud to be a member of the , and certified for .
ISO certification
Introduction
With customers worldwide relying on Patchworks to sync data between numerous systems, we understand just how vital data security and integrity are throughout our operations. Patchworks is committed to implementing and promoting Information Security best practices at every level of our organisation.
Following rigorous audits by an accredited certification body, we are delighted to see this reflected in our certification for compliance with ISO/IEC 27001:2022.
ISO/IEC 27001:2022 @ Patchworks
is the most recent update of the international standard for managing information security.
Published by the , it provides a framework for establishing, implementing, maintaining, and continuously improving an Information Security Management System (ISMS). This defines how Patchworks manages security in a holistic, comprehensive manner.
To confirm our certification, scan the QR code above, or check the link below!
Unlinking a company from your multi-company profile
Introduction
If you need to 'un-link' a managed company from your profile, please contact your Patchworks Partner Manager.
What next?
Once a company has been removed from your profile, it's no longer shown in your - none of your team members will have access from this point forward.
However, any 'native' users associated with the company can continue to log into the Patchworks dashboard with their own credentials and manage their own company as required.
Product roadmap
Introduction
We have some exciting features in the pipeline for this year and beyond! Our current roadmap is shown below.
Current roadmap
Getting started introduction
Introduction
Having registered for a Patchworks account and logged into the dashboard, you're all set to start syncing data between your business-critical systems. There are two ways to approach this:
If you registered for a Patchworks account before July 2023, you'll be familiar with using to sync data between systems. Process flows include all the functionality of services and much more. You can continue to use services but if you'd like to try , please contact your Customer Success Manager, or reach out to
Product security
The Patchworks platform is designed with robust security controls at every level of our , ensuring peace of mind for your organisation.
Security by design
Our core product is built using industry-standard frameworks, which are certified as part of our I and compliance. Our Information Security Management System is continuously updated and improved to meet the ever-changing threat landscape. From inception through deployment, security is a fundamental part of our development lifecycle.
Multi-language support
Introduction
You can work with the Patchworks dashboard in your preferred language, using the language switcher in the top information bar - for example:
When you switch languages, the dashboard fields, labels, buttons, and options are translated.
About company profiles
About this section
Having for a Patchworks account, a company profile is created for your organisation. From here you can view/update basic details for your organisation (name and contact information) and manage users.
Tech stack
Introduction
Leveraging a combination of proven technologies and innovative solutions, our tech stack is curated to provide a comprehensive, flexible environment for developing, deploying, and managing our products.
Accessing your company insights
Introduction
There are two ways to access your company insights page:
Accessing your company profile
Introduction
Having registered from a Patchworks account, a company profile is added for the company that you registered. You'll need to access this profile to update company details or to Follow the steps below to access your company profile.
Deleting a user account
Introduction
If you are a user with an , you can choose to remove another user account from your company profile.
When a user is removed, their account becomes inactive, and they can no longer log in to the dashboard. If required, a deleted user account can be .
Removing a team member account from your multi-company profile
Introduction
If your user account is associated with a , you can remove other team member accounts from your company profile.
Updating general details for an existing user account
Introduction
If you are a user with an , you can update general details for any existing user accounts associated with your company profile.
Working with 'native' company users
If you are a multi-company profile user with , you can view and manage user accounts that are directly associated with a company that you manage. These are sometimes referred to as 'native' company users. You can:
The notification centre
Introduction
When you install blueprints or process flows from the marketplace, the installation 'job' is added to a queue for completion. When the job is completed, a notification is added to your notification centre. The number of unread notifications is shown on the - from here you can , (where applicable), or .
Marketplace scripts
Introduction
The scripts page includes a range of prebuilt custom scripts. These scripts perform a range of functions that you may find useful when building process flows.
Having it can be used in your process flows immediately, via the .
Users, roles & permissions introduction
About this section
This section includes guidance for administrators to add and manage user accounts via your . It also includes guidance for all users wishing to access and manage their own user details, together with general information about passwords, roles and permissions.
Restoring a deleted user account
Introduction
If you are a user with an , you can choose to restore a deleted user account associated with your company profile.
Triggering a password reset for an existing team member
Introduction
You can trigger a password reset email for another team member in your organisation, from your own company profile.
Alternative approach
Removing a 'native' linked company user from their company profile
Introduction
If you are a multi-company profile user with , you can remove a 'native' user from their company profile.
Working with your team members
Introduction
If your Patchworks user account is associated with a multi-company profile and you have been , you are a team member with access.
As such you can perform the following tasks for other team members (i.e. other users associated with your agency/partner profile):
Technical overview
Introduction
The Patchworks infrastructure is designed for resilience and scalability - utilising cutting-edge technologies and best practices to ensure your data flows securely, efficiently, and reliably.
Leveraging a combination of proven technologies and innovative solutions, our tech stack is curated to provide a comprehensive, flexible environment for developing, deploying, and managing our Core product.
Triggering a password reset for another user
Introduction
If you are a user with an , you can trigger a password reset email for other users in your company.
When this is done, a reset email is sent to the email address for the user, containing a reset link. Password reset links are valid for 24 hours. After this, another password reset must be triggered so a new link is emailed.
Viewing all users for your company profile
Introduction
Existing users can access their company profile and view all associated user accounts. If you are a user with an , you can also access options to create and manage user accounts.
Accessing your private marketplace
Introduction
Your private marketplace can be accessed via the main Patchworks marketplace - it's simply a case of toggling between 'public' and 'private'.
Patchworks IPs
Introduction
This page details Patchworks IPs that should be whitelisted if required (typically if you are experiencing connection issues and your systems are behind a firewall).
Company insights
Introduction
Company insights can help you understand how your process flows are performing and your resource usage.
With the ability to view details for all process flows that run in a given month, and drill down to the performance of individual shapes, this is a powerful tool to help you identify areas that could be optimised for maximum efficiency.
Uploading blueprints to your private marketplace
Introduction
If you manage multiple company profiles, it's likely that you will need to share process flows and associated resources between them.
You can do this by creating your own blueprint, which can then be installed in any child companies that you manage. For more information, please refer to .
Uploading private marketplace resources
Introduction
Having built resources that you want to share, they can be uploaded to your private marketplace. You can upload a package of resources as a blueprint, or individual components (connectors, process flows, scripts, and cross-reference lookups.
Irrespective of whether you're running Patchworks Tapestry (i.e. services) or Core (i.e. process flows), please ensure that all IPs for Cluster 1 and Cluster 2 are added.
Our development team adheres to secure coding standards and best practices. Secure coding training is mandatory for all engineers (security awareness training is mandatory for everyone), and regular code reviews are an integral part of our release pipeline.
Security testing
All code repositories are tested with static and dynamic code analysis to ensure clean code, a secure product and the use of appropriate code library licensing.
Separation of customer data
Each customer is provisioned with a dedicated, tenanted database. This ensures strict data segregation.
Strong authentication measures
All passwords are hashed and salted using secure AES cryptographic algorithms. We never store plain-text passwords. Federated SSO FIDO2 Google authentication implementation is in place for all internal and privileged access roles.
Vaulted sensitive data
Sensitive application data (such as API keys and access tokens) is encrypted and securely stored in a protected vault.
Single sign-on (SSO)
Organisations can manage user authentication using their preferred single sign-on (SSO) method, choosing from a range of identity providers. SSO can be assigned at both the company and user levels.
Role-based access control (RBAC)
Role-Based Access Control (RBAC) is strictly enforced throughout the platform - both in the front-end user interface (i.e. the dashboard) and the back-end API layer. Access to features and data is granted according to user roles and permissions, ensuring the principle of least privilege is maintained.
.
If you registered for a Patchworks account after July 2023, you will be using
automatically.
Process flows
Process flows are a new, incredibly powerful tool that you can use to define smart, flexible flows to exchange data between connector instances. Process flows are built by dragging and dropping shapes onto a canvas, and then configuring those shapes to work in the way you need.
Please take a look at our Patchworks quickstart guide to get your bearings, and then navigate to the process flows section of this documentation for more detailed information.
Services
If you are an existing customer, you'll be familiar with the concept of using services to exchange data between two system connectors. If you're not ready to make the switch to process flows, that's OK - please see the section of this documentation for information that's relevant to your way of working.
As the user who registers a company for a Patchworks account, you are granted administrator access to the dashboard. This is is the highest level of access that can be associated with a company profile.
If you are an agency/partner with permissions to manage multiple companies, company profiles work a bit differently. Please refer to our Multi-company profiles section.
Our user interface combines the power of PrimeVue for feature-rich UI components, Tailwind for styling, and Vue.js for building a progressive and interactive user experience.
Business Logic
Laravel is a PHP framework known for its elegant syntax and robust features. Combined with Nuxt - an open source framework based on Vue.js, Nitro, and Vite - we have a solid foundation for server-side rendering and seamless navigation.
DevOps & Deployment
We leverage the agility and scalability of Amazon Web Services (AWS) for cloud infrastructure, Vercel for seamless deployment and hosting, Kubernetes for container orchestration, and Argo for managing and automating workflows.
Development Tools
Our development process utilises TypeScript for type safety, PHPUnit for comprehensive testing, NPM for efficient package management, and Docker for containerisation.
Data Management
We use MariaDB and MySQL for relational database management, Elasticsearch for powerful search and analytics, and Redis for high-performance caching and data storage.
The quickest way to access your company insights page is via the account summary link in the left-hand navigation bar:
Notice that you can also see a quick preview of your CPU and data usage for the current month:
General settings
Your company insights page can be accessed in settings - select the settings option (from the bottom of the left-hand navigation bar), then choose company insights:
If you are an agency/partner with permissions to manage multiple companies, company profiles work a bit differently. Please refer to our Multi-company profiles section.
The steps
Step 1
Log into the Patchworks dashboard. and select settings from the bottom of the left-hand navigation bar.
Step 2
Select my company profile:
...the manage profile page is displayed with general details at the top, and extra information in the lower pane:
From here you can:
Update general details, including company name, website, telephone and email address
Click the delete icon (trash) at the top of the user profile page. For example:
When prompted, confirm that you want to proceed. For example:
3
Delete the user
The user is removed, and you're returned to the user list. Here, you'll see that this user is associated with a restore option, so this account can be if needed. For example:
When a team member is removed in this way, they can no longer log into the Patchworks dashboard. If you want to allow a team member to continue accessing the Patchworks dashboard for multi-company profile but need to prevent them from managing other companies, you can simply revoke access to those companies. In this way, the team member retains their dashboard access.
Step 2
Move down to the extra section - you'll see a [company] users tab showing all existing user accounts. At a glance you can see each user's name, email address and role - click the name of the user that you want to update:
Step 3
Update the general details section as required:
Step 4
Click the save button at the bottom of the page.
The notifications icon is always available from the information bar at the top of the Patchworks dashboard, showing the number of unread notifications. Click this icon to view all pending notifications:
Accessing resources from notifications
Some notifications are clickable and can be used to navigate directly to the installed resource. For example, clicking the link for a process flow navigates to that process flow in edit mode, so you can complete any post-installation setup steps required:
When you select a notification and navigate to the resource, that notification is cleared automatically.
Clearing notifications
To clear all notifications in the list, use the 'trash' icon at the very top - for example:
To clear a single notification, use the 'delete' icon associated with that entry - for example:
Having selected the scripts option from the marketplace, you can browse and install prebuilt scripts:
Scripts are displayed over a series of pages, which you can step through using page numbers at the bottom of the marketplace. Each item is displayed with a name, description and an install option.
Related information
For all information about working with custom scripts, please see our Custom scripting section.
When a deleted user account is restored, the original email address is reinstated
The password last associated with the deleted account is not reinstated - you can trigger a password reset for this account, or the user can trigger their own reset.
Click the restore button associated with the required account. For example:
When prompted, confirm that you want to proceed. For example:
3
Trigger a password reset (optional)
The account is restored but remains inactive until the user sets a password. You can by accessing profile details for the user and selecting the reset password button. For example:
Alternatively, this user can select the forgot your password? link from thee dashboard login page:
Step 2
Move down to the extra section and select the [company] users tab - here you will find all 'native' user accounts associated with this company - i.e. users who are directly associated with this company profile and can log into the Patchworks dashboard with their own credentials:
Step 3
Click the name of the user account that you want to remove:
Step 4
Click the 'delete' icon at the top of the page:
Step 2
Move down to the extra section - you'll see a [company] users tab showing all existing user accounts. At a glance you can see each user's name, email address and role - click the name of the user requiring a password reset:
Step 3
Click the reset password button at the top of the page:
Step 4
The user will receive an email from Patchworks which includes a link to change their password.
If you are an agency/partner with permissions to manage multiple companies, company profiles work a bit differently. Please refer to our Managed company profiles section.
The steps
Follow the steps below to access the user list.
Step 1
Log into the Patchworks dashboard using your own Patchworks credentials.
Step 2
Log into the Patchworks dashboard, then select settings|my company profile to access your profile page - for example:
...your company profile page is displayed with general details at the top and additional information in an extra panel below:
Step 3
Move down to the extra panel, where the users tab is displayed by default and any existing users are shown.
Log into the dashboard and (if you're managing multiple company profiles) ensure that you've switched to your own profile.
2
Access the marketplace
Select marketplace from the left-hand navigation menu:
3
Choose the resource type and your private marketplace
Select a tab to view: , , , , or and click the private tab. For example:
Any resources that have been uploaded by users associated with your company profile or (for linked companies) your parent company profile, are displayed.
SOC 2 (Service Organisation Control Type 2) is a cybersecurity framework that assesses how well a service organisation protects client data.
Purpose
Developed by the American Institute of Certified Public Accountants (AICPA), the purpose of SOC 2 is to:
Ensure that client data is handled securely by third-party service providers
Build trust between a company and its customers
Demonstrate a company's maturity in handling customer data
The SOC 2 report
The SOC 2 report evaluates controls against the Trust Services Criteria, focusing on controls in five categories:
The Patchworks SOC 2 report is available upon request.
Security
Information and systems are protected against unauthorised access/disclosure, and damage to the system that could compromise availability, confidentiality, integrity and privacy. Protections include:
Firewalls
Intrusion detection
Multi-factor authentication
Availability
Systems, tools, and processes are in place to ensure systems are available for operational use. These include:
Performance monitoring
Disaster recovery
Incident handling
Confidentiality
Systems, tools, and processes are in place to ensure information is protected and available on a legitimate, need-to-know basis (applies to various types of sensitive information). These include:
Encryption
Access controls
Firewalls
Processing integrity
Resources, tools and processes are in place to ensure system processing is complete, valid, accurate, timely and authorised. These include
Quality assurance
Process monitoring
Adherence to principle
Privacy
Systems, tools, and processes are in place to ensure personal information is collected, used, retained, disclosed and disposed of according to policy (privacy applies only to personal information). These include:
Access control
Multi-factor authentication
Encryption
Viewing linked companies for your multi-company profile
Introduction
When you choose to switch into a managed company you will see a managed companies list which shows all companies that are linked to your profile.
However, if your user account has not been granted explicit access to manage companies, the 'switch' option won't be available for you to use. In this case, you can access the managed companies list via Patchworks settings, as shown below.
Need to know
The fact that a company is does not necessarily mean that you or anyone else in your team has the ability to manage it. Linked companies can only be managed by users in your team who have been .
Your Patchworks account must have the in order to view linked companies for your organisation.
The steps
Step 1
Log in to the Patchworks dashboard using your own Patchworks credentials and ensure that you are .
If you've been working in a managed company, click the arrow associated with your current company name, then select the switch companiesoption, followed by switch to original company:
For more detailed steps, please refer to .
Step 2
Click the settings option at the bottom of the left-hand navigation bar:
Step 3
Select the managed companies option:
If you don't see this option it means that your user account does not have the required manager role. In this case, .
Step 4
All linked companies for your organisation are shown:
If you have been granted permission to manage a linked company, you'll see an icon in the 'switch' column - you can use this to now. If no icon is shown it means that you have not been .
Updating the role for an existing user account
Introduction
When a new user account is created, assigning them a role is part of the initial account creation process. If you are a user with an administrator or manager role, you can change the role(s) for an existing user account - the following rules apply:
Your role
Allowed role changes
For more information please see our page.
The steps
Step 1
.
Step 2
Move down to the extra section - you'll see a [company] users tab showing all existing user accounts. At a glance you can see each user's name, email address and role - click the name of the user that you want to update:
Step 3
Move down to the roles tab and assign (and/or remove) roles as needed using the appropriate assign role / remove role buttons:
The role associated with a user determines the level of access that they have within the Patchworks dashboard - for more information please see our page.
Step 4
Save changes.
Registering for a Patchworks account
How to create a Patchworks account
Introduction
After registering for a Patchworks account, a dashboard instance is created using the provided information, with full access on a 14-day trial.
Registration steps
1
Request a trial account
Click the link below:
2
Submit request details
Complete and submit our request a trial form:
What happens next?
Following your meeting with the Patchworks Sales team, a will be created and you'll receive sign-in details via the email address provided. By default, this will be an .
Within Patchworks, user accounts are associated with a role. This roledetermines the level of access that users have within the Patchworks dashboard (subject to the active ). For more information, please see the page.
Patchworks partners
If you are a Patchworks partner managing , you can add linked company profiles after your own company profile is created.
For more information, please check our section.
Managing team members & users for multi-company profiles
Native company users. These users are directly associated with the linked company. They can log into their Patchworks dashboard with their own credentials.
Team members with access. These users are directly associated with your company - they have (or can be given) .
Criteria for accessing linked company users
The following criteria must be met for someone to access and manage linked company users. You must be:
A user
AND
Your multi-company profile is .
AND
Your user account has a .
AND
What next?
If you meet this criteria then you can and:
For information about managing company profiles for your linked companies, please see our section.
Related information
Multi-company profiles
Introduction
If your team needs to manage multiple companies and each of these companies has its own Patchworks dashboard and its own setup, how do you manage these efficiently?
This is achieved by adding required 'child' companies and then linking these to your own profile. When this is done, yours becomes a multi-company profile and your team members (with an appropriate Patchworks role) can be granted access to manage linked companies. This allows them to 'switch into' a company that they manage and perform required tasks.
Having a company, you can do everything that a user directly associated with that company can do - for example, , install , build , etc.).
In this section
Related information
Granting & revoking permission for an existing team member to manage a linked company
Introduction
If you are a multi-company profile user with permission to manage another linked company (i.e. your own user account is associated with a manager or administrator role and you have been granted permission to manage the company in question), you can grant and revoke permission for other team members to manage the same company.
The steps
Step 1
Log into the Patchworks dashboard using your own Patchworks credentials and ensure that you are .
Have you switched correctly?
Always double-check the company name after a switch to ensure that the switch was made correctly:
Step 2
Step 3
Click the name of the user that you want to update:
Step 4
Move down to the extra panel and click the managed companies tab:
All companies that are linked to yours for management are listed:
Step 5
The next step depends on the action that you wish to take:
I want to grant access
If you want to grant management access for a user, click the add company button:
I want to revoke access
If you want to revoke existing access for a user, click the delete icon and then confirm this action:
Step 6
Save the company profile.
Assigning roles for an existing 'native' linked company user
Introduction
If you are a multi-company profile user with permission to manage another linked company, you can assign different user roles for existing 'native' user accounts associated with that company.
When you , assigning the required roles is part of the initial account creation process. Steps detailed on this page can be followed if you need to assign different roles for an existing team member.
If you are a multi-company profile user with an administratoror manager role, you can change the role associated with other lesser-role company users. The following rules apply:
Your role
Allowed role changes
For more information please see our page.
The steps
Step 1
.
Step 2
Move down to the extra section and select the [company] users tab - here you will find all 'native' user accounts associated with this company - i.e. users who are directly associated with this company profile and can log into the Patchworks dashboard with their own credentials:
Step 3
Click the name of the user account that you want to update:
Step 4
The user roles tab is displayed and you'll see which roles are currently assigned for this account:
Step 5
Assign (and/or remove) roles as needed by clicking the appropriate assign role / remove role button.
If you attempt to assign a role that is outside of your own permissions, a failure message is displayed and the change will not be made.
Step 6
Save changes.
Uploading process flows to your private marketplace
Introduction
Having built, enabled, and deployed a process flow, you can upload it to the process flows section of your private marketplace. This guide walks through the steps needed to achieve this.
You only need to upload a process flow to your private marketplace if you want to make it available for your users (and your linked company users) to download as a standalone resource. If you just want to include the process flow in a blueprint, you don't need to upload it separately - please see .
Need to know
When you upload a process flow, any configured connectors, scripts, cross-reference lookups, caches and de-dupe pools will be included.
Preparation
Ensure that the process flow you want to upload is and .
The steps
Step 1
Login to the Patchworks dashboard and ensure you're switched to the correct company profile.
Any resources you upload to the private marketplace for your own 'parent' company will be available to your 'child' companies (via their private marketplaces). Similarly, any resources uploaded to the private marketplace for a 'child' company will be available to the 'parent' company AND all child-sibling companies. For more information please see .
Step 2
From the left-hand navigation menu, select process flows |process flows options - all of your process flows are listed.
Step 3
Click the name of the process flow that you want to upload - the process flow is displayed.
Step 4
Click the settings option from the actions bar:
Move down to the versions panel and ensure that the deployed version is displayed - check that this is the version that you want to upload.
If you don't want to use the version that's currently deployed, you should edit the draft and deploy this.
Step 5
Click the ellipses associated with the deployed version and select the upload to marketplace option:
You'll only see this option for a deployed process flow. If you are checking a deployed version and this option isn't shown, it's likely that your user account does not have the required permissions. Please if this is the case.
Step 6
Click the upload button to upload this process flow to your private marketplace. The upload is queued for processing and will be completed as soon as possible.
Check your for confirmation if you miss the popup message when this is done.
Marketplace cross-reference lookups
Introduction
The cross-reference lookups page includes a range of prebuilt cross-reference lookup tables. These perform a range of conversions which you can apply via a map field transformation.
Browsing cross-reference lookups
Having selected the cross-reference lookups option from the marketplace, you can browse and install cross-reference lookup tables:
Tables are displayed over a series of pages, which you can step through using page numbers at the bottom of the marketplace. Each item is displayed with a name, description and an option.
Related information
For all information about working with cross-reference lookups, please see our section.
Viewing 'native' company users for a linked company
Introduction
If you are a multi-company profile user with permission to manage another linked company, you can view all 'native' user accounts for that company - i.e. accounts for users at that company.
For more information about the different types of user associated with managed companies please see our .
The steps
Step 1
Log into the Patchworks dashboard using your own Patchworks credentials.
Step 2
that you want to review.
Have you switched correctly?
Always double-check the company name after a switch to ensure that the switch was made correctly:
Step 3
Click the arrow associated with the company name and select the [company] profile option - for example:
Step 4
Move down to the extra section and select the [company] users tab - here you will find all users who are directly associated with this company profile (and can log into the Patchworks dashboard with their own credentials):
From here you can click the name of a user to access their account profile and then update details, assign a different role, or trigger a password reset request.
Adding & managing company profile banners
Introduction
If your Patchworks account is associated with an admin role, you can add a message to be displayed as a dashboard banner. All users associated with your company profile will see this banner when they access the dashboard:
Message text is added and managed via your company profile page.
Need to know
Only admin role users can add/manage message text.
Banner text persists until the message is removed from your company profile.
Adding a banner message
Step 1
Log into the Patchworks dashboard and .
If you manage , make sure that you are switched into the company profile that you want to update.
Step 2
In the top general section, add required message text to the banner field:
Step 3
Save changes. Your banner is displayed immediately.
Managing an existing banner
To amend the text displayed in a current banner, simply change the banner field text as needed and save changes. The banner updates as soon your updates are saved.
To remove a banner, clear all text from the banner field and save changes. The banner is cleared as soon as this change is saved.
The Patchworks marketplace
Introduction
The Patchworks marketplace is your one-stop shop for a range of pre-built resources that you can install to streamline your dashboard integrations:
Here you can browse and install:
Accessing the marketplace
To access the Patchworks marketplace, log into the and select marketplace from the left-hand navigation menu:
If your user account is associated with appropriate permissions, you can also access your own .
Viewing team members for your own multi-company profile
Step 1
Log into the Patchworks dashboard using your own Patchworks credentials and ensure that you are .
Step 2
In the top, left-hand corner click the arrow associated with your company name - then select your profile:
Step 3
Move down to the extra section, where all users for your multi-company profile are displayed:
Step 4
From here you can select any user's name to access and manage their profile.
Patchworks advanced analytics
Introduction
Patchworks powers the flow of clean, consistent, real-time data across your entire commerce stack. With Patchworks Advanced Analytics, you can use that data as it was meant to be used:
One place to see how your business is performing
One engine to spot opportunities before your competitors do
One analytics layer built specifically for retail & ecommerce operators
To deliver this capability, Patchworks has partnered with analytics experts, Conjura. For pricing information, please .
Conjura & Patchworks
Conjura is a data analytics platform that centralises and transforms omnichannel data into actionable insights for online businesses.
To start using Patchworks Advanced Analytics, you will require a . You then connect systems that you want to analyse.
Accessing advanced analytics
Select the analytics option from the dashboard menu:
From here, you can log in or create a new account.
You need a separate account for the analytics platform.
Uploading cross-reference lookups to your private marketplace
Introduction
Having created and saved a cross-reference lookup, you can upload it to the cross-reference lookups section of your private marketplace. This guide walks through the steps needed to achieve this.
You only need to upload a cross-reference lookup to your private marketplace if you want to make it available for your users (and your linked company users) to download as a standalone resource.
If you just want to include the cross-reference lookup in a process flow or an app, you don't need to upload it separately - please see or .
The steps
Step 1
Login to the Patchworks dashboard and ensure you're switched to the correct company profile.
Any resources you upload to the private marketplace for your own 'parent' company will be available to your 'child' companies (via their private marketplaces). Similarly, any resources uploaded to the private marketplace for a 'child' company will be available to the 'parent' company AND all child-sibling companies. For more information please see .
Step 2
From the left-hand navigation menu, select the cross-reference lookups option - all of your cross-reference lookups are listed.
Step 3
Click the name of the lookup that you want to upload, to access details, then click the upload button:
If you don't see an upload option, it's likely that your user account does not have the required permissions. Please if this is the case.
Step 4
The upload is queued for processing and will be completed as soon as possible.
Check your for confirmation if you miss the popup message when this is done.
Marketplace connectors
Introduction
The connectors page allows you to browse, install and update all prebuilt connectors - these are 'standard' connectors that Patchworks builds and maintains.
If you need to connect a system which does not exist in the marketplace and you have an understanding of APIs and data structures, you can build your own connector with our (perhaps starting from a if a Postman collection is available).
Browsing connectors
Having selected the connectors option from the marketplace, you can browse and prebuilt connectors:
Connectors are displayed as tiles over a series of pages, which you can step through using page numbers at the bottom of the marketplace. Each connector includes general details and an option:
Related information
For all information about working with connectors and instances, please see our section.
Step 1
Log into the Patchworks dashboard using your own Patchworks credentials.
Step 2
that you want to review.
Have you switched correctly?
Always double-check the company name after a switch to ensure that the switch was made correctly:
Step 3
Click the arrow associated with the company name and select the [company] profile option - for example:
Step 4
Move down to the extra section and select the team members with access tab:
Step 5
All team members are displayed and you can see which users have permission to manage the current company, and which do not:
For information about granting and revoking access to the current company please see our guide.
Uploading scripts to your private marketplace
Introduction
Having saved and deployed a custom script, you can upload it to the scripts section of your private marketplace. This guide walks through the steps needed to achieve this.
You only need to upload a script to your private marketplace if you want to make it available for your users (and your linked company users) to download as a standalone resource.
If you just want to include the script in a process flow or an app, you don't need to upload it separately - please see or .
Preparation
Ensure that the script that you want to upload is
The steps
Step 1
Login to the Patchworks dashboard and ensure you're switched to the correct company profile.
Any resources you upload to the private marketplace for your own 'parent' company will be available to your 'child' companies (via their private marketplaces). Similarly, any resources uploaded to the private marketplace for a 'child' company will be available to the 'parent' company AND all child-sibling companies. For more information please see .
Step 2
From the left-hand navigation menu, select process flows |scripts options - all of your custom scripts are listed.
Step 3
Find the script that you want to upload - it should have a deployed status:
Step 4
Click the name of the script to access script details, then click the upload button:
You'll only see this option for a deployed script. If you are checking a deployed version and this option isn't shown, it's likely that your user account does not have the required permissions. Please if this is the case.
Step 5
The upload is queued for processing and will be completed as soon as possible.
Check your for confirmation if you miss the popup message when this is done.
Deleting a blueprint
Introduction
If a blueprint is no longer required, you can remove it entirely. Deleting a blueprint (as opposed to deleting a specific version of a blueprint) means that it's no longer displayed in your private marketplace - and therefore no longer available for your managed/'child' companies to install.
Need to know
Deleting a blueprint does not affect any existing installations.
The steps
1
Log in to your own company profile
Log in to the dashboard and (if you're managing multiple company profiles) ensure that you've .
2
Access private blueprints
Select marketplace from the left-hand navigation menu, then select
Working with private blueprints
Introduction
The most typical use case for a private blueprint is if you manage multiple company profiles and need to share a collection of process flows between them.
Having built and tested the required process flows in the 'parent' company, you can add them to a blueprint. When a process flow is added to a blueprint, all associated resources are included - i.e. connectors, scripts, caches, cross-reference lookups, and data pools.
If you need to , you can make the required changes and publish a new version. Depending how you need to work, this update can be , or you can .
More information
Uploading custom connectors to your private marketplace
Introduction
Having built a custom connector (or edited a Patchworks connector to work in a different way), you can upload it to the connectors section of your private marketplace. This guide walks through the steps needed to achieve this.
You only need to upload a custom connector to your private marketplace if you want to make it available for your users (and your linked company users) to download as a standalone resource. If you just want to include the connector in a process flow or a blueprint, you don't need to upload it separately - please see or .
The steps
Step 1
Login to the Patchworks dashboard and ensure you're switched to the correct company profile.
Any resources you upload to the private marketplace for your own 'parent' company will be available to your 'child' companies (via their private marketplaces). Similarly, any resources uploaded to the private marketplace for a 'child' company will be available to the 'parent' company AND all child-sibling companies. For more information please see .
Step 2
From the left-hand navigation menu, select process flows |connectors options - all of your installed/custom connectors are listed.
Step 3
Find the connector that you want to upload - it should be displayed with the name of your company profile (rather than Patchworks) and an upload option:
Step 4
Click the upload option.
If you don't see an upload option, it's likely that your user account does not have the required permissions. Please if this is the case.
Step 5
The upload is queued for processing and will be completed as soon as possible. Check your notification centre for confirmation if you miss the popup message when this is done:
Check your for confirmation if you miss the popup message when this is done.
Blueprints introduction
Introduction
Patchworks blueprints
A Patchworks blueprint contains everything you need to perform a specific task - for example, to sync orders between Shopify and Virtualstock Supplier.
You can browse and purchase blueprints from the . Having purchased a blueprint, it is added to your company profile and becomes available in the .
Having purchased a blueprint from the Patchworks website, it becomes available in your dashboard marketplace within 24 hours.
For more information, please refer to .
Private blueprints
A private blueprint blueprint is a blueprint that you build and publish to your . The most typical use case for a private blueprint is if you manage and need to share a collection of process flows between them.
For more information, please refer to .
Auto-scaling
Introduction
Flexible auto-scaling is a significant advantage for Patchworks users - it means you don't pay for a predetermined capacity that might only be required during peak periods, such as Black Friday.
Our flexible, auto-scaling architecture gives peace of mind by allowing you to start on your preferred plan, with the ability to exceed soft limits as needed. If you require more resources, you can transition to a higher tier seamlessly, or manage overages with ease.
Auto-scaling adjusts computing resources dynamically, based on demand - ensuring efficient, cost-effective resource management that's always aligned with real-time demand. The auto-scaling process breaks down into four stages:
Creating a new team member to manage linked companies
Introduction
If you are a multi-company profile user with , you can add new team members to your own company profile. Once a user is added you can (if required) go on to .
Assigning user roles for an existing team member
Introduction
When a , assigning them a role is part of the initial account creation process. Steps detailed on this page can be followed if you need change the role(s) for an existing team member.
If you are a multi-company profile user with an administratoror manager role, you can change the role associated with other lesser-role team members. The following rules apply:
Private marketplaces
Introduction
If you manage , it can be useful to share resources between them. With appropriate user , you can access a private marketplace for your company profile.
Any , , , or that you build can be uploaded to your private marketplace to be viewed/installed by:
About blueprint versions
Introduction
Versioning is important at different stages in the lifecycle of a private blueprint. This page summarises key details to keep in mind as you build and manage your blueprints in the Patchworks marketplace.
Triggering a password reset for an existing 'native' linked company user
Introduction
If you are a multi-company profile user with , you can trigger a password reset email for users associated with a company that you manage.
When this is done, a reset email is sent to the email address for the user, containing a reset link. Password reset links are valid for 24 hours. After this, another password reset must be triggered so a new link is emailed.
Changing the active version for a private blueprint
Introduction
The version of a blueprint is the version to be used whenever someone chooses to . By default, the initial version of a blueprint becomes active when a blueprint is created. For example:
Each time you for an existing blueprint, a new version is generated. At this point, you can choose which version should be active
Deleting a blueprint version
Introduction
Each time a blueprint is updated and published, a new version is created. Over time, you may wish to remove older versions, particularly if the number of versions is approaching .
tabs. Here you will see any blueprints that have been built by users associated with your company profile.
3
Access the manifest for the required blueprint
Click the blueprint tile that you want to manage. For example:
The blueprint manifest is displayed with the currently active version is displayed by default - for example:
4
Select the delete option
Click the ellipsis icon at the top of the page:
Then select the delete option:
5
Confirm this action
When prompted, confirm that you want to proceed with this action by entering the name of this blueprint. The required name is shown as placeholder text - for example:
Overtype this with the name displayed, then click the delete button. For example:
At Patchworks, every process flow shape has its own microservice and its own Kubernetes pod(s). The diagram below shows how this works:
Kubernetes pod auto-scaling
Metrics for Kubernetes pods are scraped from Horizon using Prometheus. These metrics are queried by KEDA and - when the given threshold is reached - auto-scaling takes place. This process is shown below:
Prometheus JSON exporter scrapes Horizon metrics for each Core microservice count.
Prometheus scrapes metrics from the JSON exporter.
KEDA queries Prometheus, checking if any Core microservice has reached the process threshold (set to 8).
If the process threshold is reached, KEDA scales the Core microservice pod.
Kubernetes node auto-scaling
The Kubernetes cluster auto-scalermonitors pods and decides when a node needs to be added. A node is added if a pod needs to be scheduled and there aren't sufficient resources to fulfill the request. This process is shown below:
TheKubernetes schedulerreads the resource request for a pod and decides if there are enough resources on an existing node. If yes, the pod is assigned to the node. If no, the pod is set to a pending state and cannot start.
The Kubernetes auto-scaler detects that a pod cannot schedule due to a lack of resources.
The Kubernetes auto-scaler adds a new node to the cluster node pool - at which point, the Kubernetes scheduler detects the new node and schedules the pod on the new node.
For a new user to manage linked companies, they must be assigned the manager role. To set this role, your own user account must be associated with the administratorrole.
To upload resources to your private marketplace, your user account must be associated with an administrator role.
To install resources from your private marketplace, user accounts must be associated with a manager role or above.
You can bundle resources into a blueprint and publish this to your private marketplace. A blueprint can include any number of process flows, with all associated connectors, scripts, cross-reference lookups, caches and data pools.
You can , , , and to your private marketplace.
To upload a process flow, it must be deployed.
To upload a script, it must be saved and deployed.
Resource visibility for linked companies
If you are a parent company administrator managing multiple linked profiles, you might upload resources to your own private marketplace and/or the private marketplace for any child company.
With this in mind, it's important to understand how resource visibility works in a parent/child company context. This is shown in the table below:
Resource uploaded to...
Resource available in...
Parent marketplace
parent company private marketplacechild company private marketplaces
Child marketplace
own child company private marketplaceparent company private marketplacesibling-child company private marketplaces
When a new blueprint is built, a draft version is created as soon as general details (name, labels, etc.) are saved. If you exit from the manifest without publishing, you'll find this draft in the unpublished blueprints section of your private marketplace. For example:
In a draft state, component counts on blueprint tiles will always be 0.
When you publish this version, it becomes version 1. By default, this becomes the active version. For more information, please refer to Building a private blueprint.
The active version
The active version of a blueprint is the version to be used whenever someone chooses to install this blueprint from your private marketplace. When a blueprint is created, the initial version becomes active by default. For example:
To update an existing blueprint, you start by opening a new draft. Having made your updates and published this draft, a new version is created with an incremented version number.
Is there a limit on the number of versions that can be published?
Yes. The maximum number of versions for any blueprint is 10. If you reach this limit and attempt to publish another version, you are prompted to confirm that the oldest version can be removed. For example:
If you would prefer to remove a different version to make way for the one, select cancel and then delete the required version before trying the publish operation again.
What if the oldest version is also the active version?
If the oldest version is also the active version, it can't be deleted automatically. In this case, you'll see an error message when attempting to publish a new version - for example:
Step 2
Move down to the extra section and select the [company] users tab - here you will find all 'native' user accounts associated with this company - i.e. users who are directly associated with this company profile and can log into the Patchworks dashboard with their own credentials:
Step 3
Click the name of the user that requires a password reset:
Step 4
Move down to the extra section and select the [company] users tab - here you will find all users who are directly associated with this company profile (and can log into the Patchworks dashboard with their own credentials):
Step 5
Click the name of the user account that you want to access:
Step 6
Click the reset password button at the top of the page:
Step 7
The user will receive an email from Patchworks which includes a link to change their password.
If you have updated an existing blueprint, we recommend promoting it to a test company/environment before it is set to active. Please refer to Updating a private blueprint for a suggested update workflow.
Need to know
When an updated version is set to active, two things happen:
An update available indicator is added to this blueprint in the private marketplace for any 'child' company profiles where it's installed. You can apply these updates in a bulk operation or individually.
The steps
1
Log in to your own company profile
Log in to the dashboard and (if you're managing multiple company profiles) ensure that you've switched to your own profile.
2
Access private blueprints
Select marketplace from the left-hand navigation menu, then select blueprints and private tabs. Here you will see any blueprints that have been built by users associated with your company profile.
3
Access the manifest for the required blueprint
Click the blueprint tile that you want to manage. For example:
The is displayed with the currently active version is displayed by default - for example:
4
Switch to the version you want to make active
Click in the version field and select the version that you want to make active. For example:
Deleting a blueprint version does not affect any existing installations of that version.
When a blueprint version is deleted, existing version numbers are unchanged, and the deleted version number is never reused.
You cannot delete the active version; in this scenario, you would need to change the active version first.
The steps
1
Log in to your own company profile
Log in to the dashboard and (if you're managing multiple company profiles) ensure that you've switched to your own profile.
2
Access private blueprints
Select marketplace from the left-hand navigation menu, then select blueprints and private tabs. Here you will see any blueprints that have been built by users associated with your company profile.
3
Access the manifest for the required blueprint
Click the blueprint tile that you want to manage. For example:
The is displayed with the currently active version is displayed by default - for example:
4
Switch to the version you want to delete
Click in the version field and select the version that you want to delete. For example:
5
Select the delete option
Click the delete version button to the right of the version number. For example:
The delete
6
Confirm this action
When prompted, confirm that you want to proceed with the delete action. For example:
There are two possible paths for new clients to get up and running with Patchworks:
Custom integrations, with help from the Patchworks team
Self-serve integrations, via the Patchworks dashboard
If yours is a custom integration, you're in safe hands! Our teams will work with you to gather requirements and implement a tailor-made solution to meet your exact needs. However, with the launch of the new Patchworks dashboard, self-serve onboarding is now possible.
In this guide, we summarise the key steps required to get up and running, with links to relevant articles to help you complete each one.
Where to start?
Key steps from initial registration through to putting process flows live are summarised in the illustration below:
Step 1: Registration
To register your company for a Patchworks account so you can access the Patchworks dashboard, use our registration link below:
You can register with a Google sign-in, or with a username and password. For details, please see: .
If you are a Patchworks partner managing multiple company profiles, the should be enabled for your account. With this in place, you can .
Step 2: Company setup
If your company is standalone and you don't need to manage other (linked) companies, you won't need to complete any further company setup.
If your company DOES need to manage other companies in Patchworks and the is enabled for your account, you can .
Step 3: User setup
Having registered for a Patchworks account, a user account is created with the credentials you provided. By default, this is an admin account.
As an admin user, you can choose to create additional user accounts so other members of your team can access the Patchworks dashboard. When you create a user account, you can choose whether that person will have admin privileges (so they can create and manage process flows in Patchworks), or simple user permissions, (so they largely have view-only access). For details, please see .
To learn more about Patchworks roles and permissions, please see: . If you are adding/updating users for a managed company profile, please see s.
Step 4: Flow setup
With your Patchworks company profile in place and users created, you're ready to start creating process flows. There are two approaches for this - , or .
Auto setup via blueprints
A includes everything you need to sync data between two systems - i.e. , , , , .
Having purchased and installed a blueprint from the (following installation instructions provided) - process flows are then ready to test and subsequently put live.
Manual setup
Here, you add/install/build all required resources - i.e. , , , , , and any other resources needed to perform given tasks.
Note that the Patchworks marketplace includes a library of connectors, process flows, scripts and cross-reference lookups that you can install and use as-is, or edit to meet specific requirements. If we don't have a prebuilt for an application you need to sync and you have some technical expertise in-house, you can use the to build your own.
Step 5: Day-to-day-management
Once a process flow is activated, it runs automatically as per any defined settings. if required, you can also choose to , with instant feedback and real-time logging.
As a process flow runs, you can see real-time progress from the , with detailed logs generated throughout the run. can also be viewed retrospectively, so you always have full oversight of what's happened with your data.
Password control
Password requirements
When setting a password for simple sign-in, the following rules apply:
A minimum length of 8 characters
At least 1 lowercase letter (a-z)
At least 1 uppercase letter (A-Z)
At least 1 number (0 - 9)
At least 1 special character (!, $, #, or %)
Password validation includes checks to determine if the password specified for registration or reset is compromised.
Checks are made using the haveibeenpwned.com service with the k-anonymity model, to determine if a password has been leaked. If a specified password is found to be compromised, it cannot be used, and you will be prompted to try again.
Password expiry
Patchworks passwords do not expire.
If you are logged into the dashboard, you can change your password by selecting the change password option associated with your avatar (in the top right-hand corner of the dashboard). For further information, please see: .
Users with an can .
Password storage
Patchworks passwords are stored in an encrypted AWS database.
Password control
Passwords can never be viewed or accessed by users, irrespective of their role.
Managing passwords for other users
Users associated with an can trigger a password reset for any users in their company profile, via the Patchworks dashboard. For more information, please see our page.
Password reset links are valid for 24 hours. After this, another password reset must be triggered so a new link is emailed.
Passwords are never set on behalf of other users.
Forgotten passwords
If you sign in to the Patchworks dashboard with an email address and password, you can at any time, from the Patchworks sign-in page:
Alternatively, use the link below:
Selecting this option displays a reset password page - enter your email address to trigger a password reset email:
The password reset email includes a link which allows you to reset your password.
Password reset links are valid for 24 hours. After this, another password reset must be triggered so a new link is emailed.
Google sign-in passwords
If you sign into Patchworks with your Google account, you won't have a password for Patchworks.
However, if a password reset is triggered for a Google sign-In user, a password reset email IS triggered and can be used to set a Patchworks password.
This does not affect your Google sign-in, it just means you can choose to log in via Google OR by entering your email address and Patchworks password.
External access
External access via the Patchworks API is granted via API tokens. For further information, please see our .
Configuring usage alerts
Introduction
Usage alerts can be configured to send automated email notifications when your company's operations usage allowance reaches a given (percentage) threshold within a billing cycle.
Need to know
Usage alerts are based on a given 'allowance used' threshold - when this threshold is reached, email notifications are triggered.
Usage is checked, and email notifications are triggered at 8 am each day. For example, if you reach your threshold at 10 am on Tuesday, users will be notified at 8 am on Wednesday.
Email notifications for any given usage alert are sent ONCE in each billing cycle.
Who can create, manage & receive usage alerts?
The ability to create, manage, and receive alerts depends on the type of company profile - specifically, whether or not you manage or are managed by another company. Possible variations are summarised in the table below:
Manages multiple company profiles
Is managed by another company
Managing company is a powered-by profile
Is a powered-by profile
Can create & manage alerts
Receives alerts for own usage
Receives alerts for 'child' companies
Users with a manager role or above can create and manage usage alerts.
The steps
1
Review, add, or update notification groups
Select settings ➤ notification groups and check that the required notification groups are in place - if not, create them. For detailed information, please see our section.
Two-factor authentication (2FA)
Introduction
Two-factor authentication (2FA) is a subset of multifactor authentication (MFA). It typically uses a one-time time-based passcode (TOTP) to add an extra layer of security to the user’s account.
How it works - technical
Generally, 2FA works as follows:
A secure string of letters and numbers (known as a secret key) is generated.
This string is shared with an authenticator app on the user’s mobile device - usually by scanning a QR code.
The authenticator app uses the secret key, along with the current date/time to generate a code. These codes expire after a short period of time and a new one is generated.
How it works - user journey
When 2FA is enabled for your Patchworks account, you will log into the dashboard as normal with your username and password. Having entered your credentials, you are prompted to enter an authentication code, which you obtain from your authenticator app:
Need to know
To enable 2FA for your Patchworks login, you will need an authenticator app - for example (but not limited to Google Authenticator, Microsoft Authenticator, Duo, Authy).
Enabling 2FA for your Patchworks login
To enable 2FA for Patchworks, follow the steps below:
Step 1
Log into the Patchworks dashboard.
Step 2
Select settings (from the bottom of the left-hand navigation menu):
Step 3
Select my account settings:
Step 4
Select the multi-factor authentication tab:
Step 5
Click the enable button:
...setup information is displayed with a QR code:
Step 6
Open your preferred authenticator app and scan the QR code.
Step 7
Your authenticator app will generate a 2FA code, which you should enter in the Patchworks multi-factor authentication tab, then click confirm::
Step 8
A set of recovery codes is displayed, which can be used in the event that you can't access your authenticator app for any reason. Copy these codes somewhere secure (such as a password manager).
Step 9
Click the copied button to confirm that you've copied recovery codes - the setup is now complete:
The next time that you log into Patchworks, you'll be prompted to enter a 2FA code (generated by your authenticator app) before you can access the dashboard:
Disabling 2FA for your Patchworks login
To disable 2FA for Patchworks, follow the steps below:
Step 1
Log into the Patchworks dashboard.
Step 2
Select settings (from the bottom of the left-hand navigation menu):
Step 3
Select my account settings:
Step 4
Select the multi-factor authentication tab:
To access your account settings, click your login name in the top, right-hand corner of the dashboard, then select the account settings option:
Changing your account name or email address
Step 1
Access your page.
Step 2
Update information in the general panel as needed:
Remember that the email address specified here is used to log into the Patchworks dashboard.
Step 3
Click the save button.
Enabling/disabling two-factor authentication
If you want to enable/disable two-factor authentication for your account, move down to the extra panel and select the multi-factor authentication tab:
For more information please see our .
Changing your password
Step 1
Click your login name in the top, right-hand corner of the dashboard, then select the change password option:
Step 2
Complete the change password form by entering your existing password, followed by the new required and confirmation of this:
When setting your password, the following rules apply:
A minimum length of 8 characters
At least 1 lowercase letter (a - z)
Step 3
Click the submit button to save changes.
You may notice that there's a reset password option at the top of your page. This option triggers a password reset email which includes a link to the password reset form shown above - so you achieve the same thing but with an extra step.
Adding & linking a new company
Adding & linking a new managed company for Patchworks partners and agencies.
Your is associated with an allowance for the number of companies that can be created in each subscription tier.
If you don't have the but require new linked companies to be added, please contact your Patchworks Partner Manager.
The steps
The steps to add a new, linked company profile are summarised below:
Stage 1: Create a new company profile
1
Log in & switch to your partner profile
Log in to the Patchworks dashboard using your own Patchworks credentials and ensure that you are .
If you've been working in a managed company, click the arrow associated with your current company name, then select the switch companiesoption, followed by switch to original company
Stage 2: Access the new company profile
1
Switch to the new company
Use the 'switch' icon associated with the new company to switch into that profile - for example:
2
Access profile details
In the top-left corner, click the arrow associated with the new company name and select the
Stage 3: Add users & review team member access
Having switched to the new managed company and accessed profile information, move down to the extra panel.
If you need to for the company who can then log in directly and access their own dashboard, select the users tab. For example:
For information about working with managed company users, please refer to .
All team members associated with your partner profile are granted access to the new company, automatically. To review and update team access, select the team members with access tab. For example:
For information about working with team members, please refer to .
Stage 4: Set subscription details
By default, new company profiles are associated with a trial subscription. To update this, select the subscriptions tab:
From here, you can choose the appropriate subscription.
The number of trial, standard and professional tier profiles allowed is determined by your own partner/managing company profile. For information about subscription tiers, please refer to our page.
Creating a new user account for your company profile
Introduction
If you are a user with an administrator or manager role, you can create new user accounts for your company profile. These users will be able to log into the dashboard for your company - the level of access that they have will depend on the role that you grant during the account creation process.
By default, new users are created with a user role. Provided that you have an administratoror manager role, you can change this if required - the following rules apply:
Your role
Allowed role changes
For more information, please see our page.
If you are an agency/partner with permissions to manage multiple companies, company profiles work a bit differently. Please refer to our section.
The steps
Step 1
.
Step 2
Move down to the extra section - you'll see a [company] users tab showing all existing user accounts. At a glance, you can see each user's name, email address and role - for example:
Step 3
Click the create user button:
Step 4
Enter the person's name and email address:
The email address provided here is used to log into the Patchworks dashboard.
Step 5
Click the save button. The user account is saved, and an email is sent to the given address, with a link for the user to set their password.
If the email address specified is associated with an existing (active) user account, you are prompted to enter a different address. If the email address specified is associated with a deleted user account, you are prompted to restore this account.
Step 6
The user roles tab is displayed, and you'll see that the new account is created. By default, new accounts are created with a userrole:
If required, you can assign an alternative role by clicking the appropriate button.
Roles determine the level of access that users have in the Patchworks dashboard. See the table for roles that you can set here.
Step 7
Save changes. Once the user has set their password (via the link provided in an email triggered in step 6) they can access the Patchworks dashboard for their own company.
About operations
Introduction
In Patchworks, an operation is counted whenever a request is made to send or receive a payload to/from an endpoint or query.
Crucially, we're not concerned with the number of items in the payload - we simply count the number of times a process flow requests to send or receive a payload. This might happen in several ways:
Mechanism
Summary
Considerations for your operations count
The number of payloads that a process flow sends or receives correlates with the number of operations logged. In the most straightforward case, you might create a process flow that always receives a single, unpaginated payload from one system and then sends a single, unpaginated payload to another system - this would be an operations count of 2.
However, as the complexity of a process flow increases, so too does the potential for an increase in the number of payloads being processed. The most likely ways that this can happen are:
Paginated data. If you receive paginated data, you receive 1 payload for each page of data - so each page represents 1 receive operation. In short, an initial data pull can result in multiple receive operations. And if you receive multiple pages, it follows that multiple pages continue through the flow - which means (potentially) multiple pages will be sent into your destination system, resulting in multiple send operations.
Flow control. The shape is typically used to batch an incoming payload into multiple, smaller payloads for onward processing. So, even if you start by receiving 1 payload, it's likely that you will be sending multiple payloads at the end of the flow.
Retries for failed connection requests are included in your operations count. For more information on connector retry settings, please see .
Examples
The examples below show the impact that these scenarios can have on operation counts:
Downloading a linked companies summary
Introduction
You can download summary details for all of your linked companies via the managed companies page.
Details for your own (managing) profile are also included.
The following details are provided for each of your linked companies:
Item
Notes
Need to know
The fact that a company is does not necessarily mean that you or anyone else in your team has the ability to manage it. Linked companies can only be managed by users in your team who have been .
Your Patchworks account must have the in order to view linked companies for your organisation.
The steps
Step 1
Log into the Patchworks dashboard using your own Patchworks credentials and ensure that you are .
If you've been working in a managed company, click the arrow associated with your current company name, then select the switch companiesoption, followed by switch to original company:
For more detailed steps, please refer to .
Step 2
Choose to for a list of all companies that you have permission to manage:
Step 3
Click the downloadbutton:
If you don't see this option it means that your user account does not have the required manager role. In this case, .
Step 4
The CSV file is generated and saved to the default downloads folder for your browser.
Submitting a connector for the public marketplace
Overview
This document outlines the approval process for developers submitting public connectors for inclusion in the [Public Marketplace]. The [Public Marketplace] is a platform where users can discover, install, and use a range of pre-built connectors to accelerate the onboarding process.
For in-depth guides on how to build a connector, please see our section. For a demonstration video of our connector builder, watch our CEO Jim Herbert build a connector in under 5 minutes:
Switching in & out of a linked company
Introduction
The steps detailed on this page show how to switch into a linked company that you manage and - when you've finished working with that company - how to .
Creating a new 'native' user for a linked company
Introduction
If you are a multi-company profile user with , you can add a new 'native' user for that company.
Marketplace blueprints
Introduction
A Patchworks blueprint contains everything you need to perform a specific task - for example, to sync orders between Shopify and Virtualstock Supplier.
When you , all of its components (connectors, process flows, scripts, etc.) are installed and added to the relevant area of your Patchworks dashboard - connectors are added to your , process flows are added to your , custom scripts are added to etc.
Installing a private blueprint
Introduction
Having published a new blueprint, it becomes available in your private marketplace immediately. If If you're managing multiple company profiles, it will be visible to all 'child' companies that you manage.
The blueprint installation process has two key parts:
When authenticating with an application, the user is prompted to retrieve the current code from their authenticator app and input it into the application. If the code matches what the application has generated, the user is authenticated.
The system continuously monitors traffic and resource usage (CPU, memory).
When usage exceeds predefined thresholds, the auto-scaler triggers.
Additional resources/pods are deployed to handle the increased load
When demand drops, resources are reduced to optimise costs.
You can define any number of usage alerts. For example, you might add one alert to trigger notifications when usage exceeds a 50% threshold, another for 30%, and another for 10%.
yes
yes
n/a
no
yes
no
n/a
yes
yes
n/a
no
yes
yes
n/a
no
no
n/a
yes
n/a
n/a
no
yes
yes
no
yes
n/a
n/a
yes
yes
yes
yes
If you need multiple alerts with different recipients for different usage thresholds, you should define multiple notification groups.
If you are a developer seeking to submit a public connector for inclusion in the [Public Marketplace], you must ensure that their connector meets the following requirements.
Requirement
Summary
Compliance
The connector must comply with all relevant laws, regulations, and policies, including those related to data privacy, security, and intellectual property rights.
Functionality
The connector must provide clear and useful functionality that adds value for users. It should be well-designed, intuitive to use, and free from significant bugs or issues.
Quality
The connector must meet quality standards for performance, reliability, and user experience. It should not degrade the performance or stability of the [Public Marketplace] platform.
Security
Submission Process
The submission process for public connectors consists of the following steps:
Before the development of the connector commences, you are encouraged to submit in writing (to your partner manager) the following details on any connector(s) you intend to create.
Item
Summary
Developer name
The name and email address of your company or developer.
Patchworks company profile
The Patchworks dashboard company profile name under which you will create the new connector(s).
Connector name
The name of the connector to be displayed in the [Public Marketplace].
Expected completion date
Step 2: Pre-submission review
Before submitting a connector for approval, you are encouraged to conduct a thorough review of your connector to ensure it meets all requirements outlined above.
This includes testing the connector for functionality, performance, and security.
Step 3: Connector submission
Once the connector is ready, you can submit it via your account manager. The submission should include the following:
Documentation and user guides (if required)
Screenshots or demo videos (if applicable)
Contact information for the developer or support team
Step 4: Review meeting
Once the connector and associated information are submitted, the [Public Marketplace] team will schedule a review meeting with the developers. During this meeting, you should be prepared to:
Demonstrate working flows by showing data transmission between source and destination endpoints.
Review any scripts or custom components used in the connector authentication & endpoints.
Post-approval responsibilities
After a connector is approved and listed in the [Public Marketplace], you have certain responsibilities to maintain the connector's quality and compliance.
Responsibility
Summary
Updates & maintenance
You should regularly update and maintain you connector(s) to ensure it remains compatible with the [Public Marketplace] platform and any relevant changes or updates.
Support
You must provide adequate support to users, including addressing enquiries, issues, and bug reports in a timely manner.
Compliance
You should continue to comply with all relevant laws, regulations, and policies, and promptly address any compliance issues that arise.
Conclusion
The approval process outlined above is designed to ensure that public connectors included in the [Public Marketplace] meet our high standards for quality, functionality, and security. By following this process and meeting our submission requirements, you can contribute to a vibrant ecosystem of third-party apps that enhance the user experience on the Patchworks platform.
For further information or assistance with the connector submission process, please refer to the [Public Marketplace] developer documentation or contact the [Public Marketplace] support team.
If your organisation manages lots of companies, this list might be long, running over multiple pages. You can use the search field to find a company by name.
Step 2
Click the ‘switch’ icon to the right of the required company profile:
Step 3
You are switched into this company profile:
Notice that the company name has changed at the top of your window - if you click the associated arrow, you'll find quick access to profile settings for this company, should you need to change general details or manage company users:
Any changes that you make from this point on will update the company you have switched into. Always ensure that you are switched to the right company before making changes.
At the top of this page, you'll find a copy company link button, which can be used to copy a link to this company profile:
This is useful if you want to collaborate with other team members (who have sufficient permissions) - they can access the company directly via this link, seamlessly switching to the relevant company profile.
If required, you can copy process flows from one of your managed companies into another. For further information please see
Step 5
When you've finished working with this company, you should switch back to your own company to ensure that you don't make any subsequent updates in error.
Switching back to your own company
When you've finished working with a managed company, follow the steps below to your own (i.e. original) company.
Step 1
Click the arrow associated with your current company name and select the switch companies option:
Native users can log into the Patchworks dashboard to work with their own company profile, using their own login credentials. For more information about the different types of user associated with managed companies please see our managed company users introduction.
By default, new users are created with a user role. If you are a multi-company profile user with an administratoror manager role, you can change this if required - the following rules apply:
Your role
Allowed role changes
Administrator
Can assign roles up to and including manager level (e.g. change a user account to a manager account).
Can reduce other non-administrator accounts to a lesser role (e.g. change a user account to a read-only
Manager
Can assign roles up to and including user level (e.g. change a read-only account to a user account).
Can reduce other non-manager accounts to a lesser role (e.g. change a user account to a read-only
Step 2
Move down to the extra section and select the [company] users tab - here you will find all 'native' user accounts associated with this company - i.e. users who are directly associated with this company profile and can log into the Patchworks dashboard with their own credentials:
Step 3
Click the create user button:
Step 4
Enter the person's name and email address:
The email address provided here is used to log into the Patchworks dashboard.
Step 5
Click the save button. The user account is saved and an email is sent to the given address, with a link for the user to set their password.
A password must be used with the user's email address in order to log into the Patchworks dashboard.
Step 6
The user roles tab is displayed and you'll see that the new account is created - by default, new accounts are created with a userrole:
If required, you can assign an alternative role by clicking the appropriate button.
Step 7
Save changes. Once the user has set their password (via the link provided in an email triggered in step 5) they can access the Patchworks dashboard for their own company.
Blueprints can be purchased from the Patchworks website. Having purchased a blueprint, it will be available to install from the blueprints tab in the marketplace:
Having purchased a blueprint from the Patchworks website, it becomes available in your dashboard marketplace within 24 hours.
Once a blueprint becomes available in your marketplace, you'll see it displayed as a tile which includes a visual summary of component parts - for example:
Here you can see which connectors are included in the blueprint, the blueprint title and creator, and a summary of contents. Summary icons are:
Icon
Shows
The number of included .
The number of included .
The number of included .
Blueprint contents
For a detailed view of what's included in a blueprint, click anywhere on the tile. This displays full details for the blueprint - from here, you can view all components and if required, you can choose to install the blueprint.
Install. To install the blueprint, switch to the required company profile and then run the install from the private marketplace.
Deploy flows. Once the installation is complete, the associated process flows must be deployed. How this is done depends on which option you set for the installation.
When a blueprint is installed, the current active, version is used. For a new blueprint, the active version is always the initial version; however, the active version is likely to change if the blueprint is subsequently updated.
The steps
1
Log in and switch to the required company profile
Log in to the child company dashboard.
2
Access private blueprints
Select marketplace from the left-hand navigation menu, then select blueprints and private tabs. Here you will see any blueprints that have been built from the 'parent' company, or from the child company itself.
3
Select the required blueprint
Click the blueprint tile that you want to install. For example:
The blueprint manifest is displayed so you can see all flows and associated resources that will be installed. For example:
4
Add connector instances
Move down to the connectors section and add your required instances for each connector. For example:
For general guidance on adding connector instances, please refer to . Providing credentials for instances here means that process flows will be installed with all required setup. If you don't add an instance (or select an existing one) here, you will need to create them after the installation, then manually update connector shapes in process flows.
5
Install the blueprint
Click the install button at the top of the page. For example:
6
Choose install options
Choose what should happen immediately after the installation has completed. For example:
Available options are summarised below:
Field
Summary
7
Post-install actions
If you selected none in the previous step, process flows will be installed but not deployed. You should access each installed process flow and
If you selected package flows in the previous step, you should and then .
The package and redeploy option is not appropriate for new installations but if you did select it, you should and then .
Connector shape
A request is made (successfully or otherwise) to receive data froma specified endpoint/query.
Connector shape
A request is made (successfully or otherwise) to send data toa specified endpoint/query.
Webhook trigger
A webhook is received (with or without a payload) in the first step of the process flow.
Event trigger
An event is received (with or without a payload) in the first step of the process flow.
Patchworks API call
A Patchworks API call is received (with or without a payload) in the first step of the process flow.
In the simplest of flows you might receive 1 payload from a source endpoint which contains 350 records in a single, unpaginated payload. The flow goes on to send that payload to a destination endpoint.
This results in 2 operations - 1 for the receive operation and 1 for the send operation.
In a slightly more complex flow you might receive 1 payload from a source endpoint which contains 350 records in a single, unpaginated payload.
The flow continues with a shape which batches this data into smaller chunks, resulting in 5 payloads, each containing 70 records. The flow goes on to send all of these payloads to a destination endpoint.
This results in 6 operations - one for the receive operation and 5 for the send operations.
In this example, our incoming data is paginated as 50 records per page, so we receive 350 records as 7 payloads (50 records in each).
The flow proceeds to send all of these payloads to a destination endpoint.
This results 14 operations - 7 for receive operations and 7 for send operations.
In this example, our incoming data is paginated as 50 records per page, so we receive 350 records as 7 payloads (50 records in each).
The flow continues with a shape which batches this data into single-item payloads. The flow goes on to send all of these payloads to a destination endpoint.
This results 357 operations - 7 for receive operations and 350 for send operations.
A blueprint can include any number and combination of the following components:
Resource
Notes
Viewing the contents of a blueprint
Each blueprint in your marketplace is displayed with a visual summary of what's included - for example:
For more information about this summary please see .
If you click on a blueprint tile, you can see a detailed breakdown of what's included:
From here you can:
Adding authentication credentials for connector instances
Any connectors included with the blueprint are installed as part of the install process. To use these connectors in process flows, you must add an of each - this is where you provide your authentication credentials for the associated third-party system.
If you have your credentials to hand, add them now using the add instances options provided - for example:
You are prompted to choose an authentication method and then enter your credentials - for example:
When you save instance details and then , these instances are created as part of the installation. As a result, all connector shapes in process flows will be configured with these instances automatically.
It's not mandatory to add your instances as part of the blueprint installation. You can install the blueprint and . If you do this, you must apply these instances to process flow connector shapes manually.
You cannot add instances that require OAuth 2 (Client Credentials) authentication, via the blueprint install process. If a blueprint includes connectors that require OAuth 2 (Client Credentials) authentication then you should install the blueprint and . If you do this, you must apply these instances to process flow connector shapes manually.
Excluding process flows from a blueprint installation
If a blueprint includes a process flow that you're sure you don't need, you can prevent it from being installed here - clicking the install button toggles to don't install:
Typically, process flows are key to the successful implementation of blueprints. We recommend installing all included process flows unless you have a specific reason not to do so.
Submitting a blueprint to the public marketplace
If you would like to create an app and submit it for review to be added to the public app marketplace, we have outlined the following submission guide to ensure a high standard.
Overview
This document outlines the approval process for developers submitting blueprints for inclusion in the Patchworks marketplace. The Patchworks marketplace is a platform where users can discover, install, and use various pre-built blueprints to accelerate the onboarding process.
Submission requirements
You must ensure that your blueprint meets the following requirements.
Requirement
Summary
Submission Process
The submission process for public blueprints consists of the following steps:
Step 1: Declaration of intent
Before the development of the blueprint commences, you are encouraged to submit in writing (to your partner manager) the following details on any blueprint(s) you intend to create.
Item
Summary
Step 2: Pre-submission review
Before submitting a blueprint for approval, you are encouraged to conduct a thorough review to ensure that your blueprint meets all requirements outlined above.
This includes testing for functionality, performance, and security.
Step 3: Blueprint submission
Once the blueprint is ready, you can submit it via your account manager. The submission should include the following:
Documentation and user guides
Screenshots or demo videos
Contact information for the developer or support team
Step 4: Review meeting
Once the blueprint and associated information are submitted, the Patchworks team will schedule a review meeting with the developers. During this meeting, you should be prepared to:
Go over the changes required for connectors, if any.
Review the proposed process flows and confirm their functionality.
Demonstrate working flows by showing data transmission between source and destination systems.
Post-approval responsibilities
After a blueprint is approved and listed in the Patchworks marketplace, you have certain responsibilities to maintain the app's quality and compliance.
Responsibility
Summary
Conclusion
The approval process outlined above is designed to ensure that public blueprints included in the Patchworks marketplace meet our high standards for quality, functionality, and security. By following this process and meeting our submission requirements, you can contribute to a vibrant ecosystem of third-party blueprints that enhance the user experience on the Patchworks platform.
For further information or assistance with the blueprint submission process, please refer to the Patchworks support team.
Updating a private blueprint
Introduction
As a user associated with the company profile that built a blueprint, you can make changes to the blueprint and publish an updated version. This guide walks through the steps required to achieve this.
Need to know
Blueprints built and installed before 5th November 2025 cannot be updated. If you have older blueprints but want to utilise the update functionality, you should and new versions.
A blueprint can have up to ten versions. If you attempt to publish a new version that would exceed this limit, you are prompted to confirm the deletion of the oldest version (first in, first out). For more information, please refer to .
When updating a blueprint, you can add new and remove existing process flows. When an existing blueprint installation is updated to this version, all associated process flows are 'un-deployed' first. If you have removed a flow from the updated version, that flow remains in place, but it is not redeployed for the company.
Suggested workflow for updating blueprints
The suggested workflow for updating and then rolling out a private blueprint is as follows:
1
Make changes to the blueprint and publish a new version
Make your required changes in a draft, then publish a new version (as detailed ).
At this point, the updated version is not , - i.e. it will NOT be installed if someone chooses to . For more information about the active version of a blueprint, please refer to .
2
The steps
1
Log in to your own company profile
Log in to the dashboard and (if you're managing multiple company profiles) ensure that you've .
2
Access private blueprints
Select marketplace from the left-hand navigation menu, then select
The connector must implement appropriate security measures to protect user data and prevent unauthorised access or misuse. It should follow best practices for secure coding and data handling.
Marketplace compatibility
The connector should be compatible with the [Public Marketplace] platform and any relevant operating systems or devices. It should not rely on unsupported features or dependencies.
Documentation (recommended)
Developers should provide clear and comprehensive documentation for their connector, including installation instructions, usage guidelines, and troubleshooting tips if any are required.
If known, provide the expected completion date for development.
All connectors used in process flows are installed. Prior to installation, you can choose to add required connector instances - or you can just install the connectors and add instances later.
If the blueprint includes a connector that you have already installed from the connector marketplace, a fresh copy of that connector is added alongside the existing one. You can then decide which one to use.
Any caches and cache keys defined in process flow add to cache shapes are added. These are 'clean' caches (i.e. with no associated data), ready for use.
Enter a value between 1 and 100. This is the percentage of your operation allowance that must be used to trigger alert emails. For example, entering 50 will trigger the alert when 50% or more of your allowance has been used.
Notiication group
Use the dropdown list to select the required notification group. You can select one notification group per alert.
account).
account).
Marketplace compatibility
The blueprint should be compatible with the Patchworks platform and any relevant operating systems or devices. It should not rely on unsupported features or dependencies.
Connector compatibility
The blueprint should use existing connectors found in the Patchworks marketplace. Any modifications to existing connectors in order to support the blueprint must be submitted separately prior to the blueprint review process.
Documentation
You should provide clear and comprehensive documentation for your blueprint, including installation instructions, usage guidelines, and troubleshooting tips if any are required.
Documentation can be provided as http links in multiple sections of the connector builder.
Alternatively documentation can be submitted along with your blueprint. We will host this documentation on our public documentation platform.
Specify the name of any connectors to be included in the new blueprint(s). If these connectors do not exist or require modifications, you must provide details about the required modifications.
Process flows
Provide information about any process flows that you intend to build utilising the specified connectors. This information should include the purpose of the process flow and any custom scripts that will be built.
Review any scripts or custom components used in the blueprint.
Compliance
The blueprint must comply with all relevant laws, regulations, and policies, including those related to data privacy, security, and intellectual property rights.
Functionality
The blueprint must provide clear and useful functionality that adds value for users. It should be well-designed, intuitive to use, and free from significant bugs or issues.
Quality
The blueprint must meet quality standards for performance, reliability, and user experience. It should not degrade the performance or stability of the Patchworks platform.
Security
Developer name
The name and email address of your company or developer.
Patchworks company profile
The Patchworks dashboard company profile name under which you will create the new blueprint(s).
Blueprint name
The name of the blueprint to be displayed in the Patchworks marketplace.
Expected completion date
Updates & maintenance
You should regularly update and maintain you blueprint(s) to ensure it remains compatible with the Patchworks platform and any relevant changes or updates.
Support
You must provide adequate support to users, including addressing enquiries, issues, and bug reports in a timely manner.
Compliance
You should continue to comply with all relevant laws, regulations, and policies, and promptly address any compliance issues that arise.
The blueprint must implement appropriate security measures to protect user data and prevent unauthorised access or misuse. It should follow best practices for secure coding and data handling.
If known, provide the expected completion date for development.
If necessary, you can deselect items shown here. However, keep in mind that blueprints are designed and configured to work with the resources shown - you should only deselect items if you are confident that it's safe to do so.
The blueprint is installed, but the associated process flows are not deployed. Use this option if are not implemented for target company profiles.
Package flows
The blueprint is installed and the associated process flows are added to a new - however, the package is not deployed.
When this option is selected, a new package is created. The package name is set to the blueprint name, followed by the version and creation date. For example:
Do not use this option if are not implemented for target company profiles. A package must be deployed to a virtual environment - it can't be deployed to no environment. In this scenario, you should select none instead.
Package and redeploy
This option is intended for use when that's already installed - it should not be used if you are installing a blueprint to a company for the first time.
Do not use this option if are not implemented for target company profiles. A package must be deployed to a virtual environment - it can't be deployed to no environment. In this scenario, you should select none instead.
The default setting is determined when the blueprint is built, but can be changed for each installation.
You can change the component parts of an existing process flow in a blueprint - for example, apply different connectors, cross-reference lookups, or scripts. When an existing blueprint installation is updated to this version, the new components are installed; the old components stay in place but are not referenced in the updated flows.
For testing purposes, you may choose to install a new blueprint in your own company or to have a dedicated 'child' company for testing.
3
Test the blueprint
Install and test the blueprint. If necessary, make and publish further updates (promoting each one to your test company for checks).
4
Set the final version as active
When you're satisfied that a published version is ready for general use, set it to be the active version.
An empty blueprint manifest opens in draft mode so you can add the required flows and (if necessary) adjust components as needed:
Ensure that all process flows to be included in the blueprint are selected. If a process flow is not selected, it is not included.
Remember that adding a process flow to a blueprint also adds its components (such as connectors, scripts, cross-reference lookups, etc.).
6
Publish the updated version
If you're ready to install/test this version, click the publish button at the top of the manifest. For example:
A blueprint can have up to ten versions. If you reach this limit and attempt to publish another version, you are prompted to confirm that the oldest version can be removed. For example:
If you would prefer to remove a different version to make way for a new one, select cancel and then before trying the publish operation again.
Also note that if the oldest version is also the active version, it can't be deleted automatically. In this case, you'll see an error message when attempting to publish a new version - for example:
In this case, you need to before trying the publish operation again.
A Patchworks blueprint contains everything you need to perform a specific task - for example, to sync orders from TikTok Shop to Shopify; to sync customers from Shopify to HubSpot, etc.
For more information please see: .
Canvas
See .
Dashboard
Having registered for a Patchworks account, use your credentials to log in to the . This is where you can access everything you need to set up and manage data exchanges between third-party applications.
For more information please see: .
Connector
The meaning of connector varies, depending on whether you are using or to sync data in Patchworks. Please expand the appropriate definition below.
Connectors in process flows
Connectors and are the key building blocks in .
A connector is a generic integration of a third-party business system/application - it contains everything needed 'under the hood' (for example, endpoints, authentication methods, etc.) to sync data from/to the associated application.
You must for any third-party application that you wish to integrate with Patchworks. As you'd expect, Patchworks has made this easy for you, with a curated library of prebuilt connectors in the .
Connectors in services
A connector is the mechanism that Patchworks uses to configure a for use in - it's how we store your system credentials in a single, easy-to-manage place. For more information please see: .
Connector builder
If you need to integrate a third-party application that doesn't have a prebuilt connector in the - and if you have technical knowledge of APIs and working with data structures - you can use the to integrate any application with REST or SOAP APIs.
For more information please see: .
Instance
An instance is the mechanism that Patchworks uses to configure a connector for use in - it's how we store your system credentials for a given connector in a single, easy-to-manage place.
You can add as many instances of a single connector as you need. For example, if you've installed the Shopify connector, you would go on to add one instance of this connector for every Shopify store that you need to sync using process flows.
For more information please see: .
Marketplace
With Patchworks, you can and then use of a range of curated, prebuilt connectors which are available from the .
Patchworks
Typically, when we talk about Patchworks in this documentation set, we're referring to the Patchworks Integration Platform as a Service (iPaaS), which is accessed via the Patchworks .
Process flow
Introduced in June 2023, the process flow feature is a completely new way to define if, when, what, and how data is synced between your third-party applications.
Process flows are built by dragging and dropping automated onto a , and then configuring them as required.
For more information please see: .
Process flow canvas
The canvas includes everything you need to build a . Here, you drag from the shapes tray, drop them onto the canvas, and then configure settings and relationships as required.
For more information please see: .
Process flow shapes
When you a process flow, a set of shapes is available from the . Each shape performs a specific task - for example, the shape is used to define a schedule upon which the process flow runs. Having dropped a shape onto the canvas, you can configure it with the required settings for that process flow.
For more information please see: .
Services
A service is the original Patchworks mechanism for defining if, when, what, and how data is synced via Patchworks. If you registered for a Patchworks account before July 2023, you'll be familiar with using to sync data between systems.
Process flows include all the functionality of services and much more. You can continue to use services but if you'd like to try , please contact your Customer Success Manager, or reach out to .
If you registered for a Patchworks account after July 2023, you will be using automatically.
Shapes
See .
System
When working with to sync data in Patchworks, a system is a Patchworks integration for a third-party business system - for example, Shopify.
For more information please see: .
The concept of 'systems' is only relevant if you use Patchworks to sync data - it is not used in .
Building a private blueprint
Introduction
This guide steps through the process of building and publishing a new, private blueprint. As soon as a blueprint is published, it becomes available for any of your linked (i.e. child) companies to install.
If you'd like to make your blueprint available in the Patchworks public marketplace, you should
Need to know
To build blueprints, your user account must be associated with an administrator role. For more information, please refer to our page.
To be available for selection in a blueprint, a process flow must be deployed (either to a virtual environment or to no environment).
When process flows are selected for inclusion in a blueprint, the last deployed version is added.
The steps
1
Log in to your own company profile
Log in to the dashboard and (if you're managing multiple company profiles) ensure that you've .
2
Build & deploy required process flows
Ensure that all required process flows are built, tested, and deployed - for example:
Blueprint drafts
As soon as you confirm the general details for a blueprint (step 6 ), the blueprint is saved to the unpublished section of your private marketplace. For example:
From here, you can click any item to access the manifest, then make changes and publish the blueprint.
In a draft state, component counts on blueprint tiles will always be 0.
What next?
Having published a new blueprint, it becomes available in your private marketplace, ready for child companies to install.
When installing the blueprint for a child company for the first time, . Thereafter, any updates can be promoted automatically.
Published blueprint options
At the top of the configuration page for a published blueprint, you'll see some new options:
With a PingOne SSO implementation, users log into the Patchworks dashboard from PingOne. Your PingOne administrator determines who has access to Patchworks and these users will see a Patchworks app in their PingOne dashboard.
Selecting this app directs the authenticated user to the Patchworks dashboard, where they are logged in directly. PingOne users never see or require a password to access the Patchworks dashboard.
Azure AD / Entra
Introduction
With an Azure AD / Entra SSO integration, users log into the Patchworks dashboard from Azure AD / Entra. Your Azure AD / Entra administrator determines who has access to Patchworks and these users will see a Patchworks app in their Azure AD / Entra dashboard.
Selecting this app directs the authenticated user to the Patchworks dashboard, where they are logged in directly. Azure AD / Entra users never see or require a password to access the Patchworks dashboard.
Okta
Introduction
With an Okta SSO implementation, users log into the Patchworks dashboard from Okta. Your Okta administrator determines who has access to Patchworks and these users will see a Patchworks app in their Okta dashboard - for example:
Selecting this app directs the authenticated user to the Patchworks dashboard, where they are logged in directly. Okta users never see or require a password to access the Patchworks dashboard.
Marketplace process flows
Introduction
The process flows section of the marketplace allows you to browse and a range of prebuilt :
A prebuilt process flow includes all resources that are needed, including:
A process flow must be deployed before it can be added to a blueprint.
3
Access the blueprints section of the marketplace
Select marketplace from the left-hand navigation menu, then select blueprints and your private marketplace. For example:
4
Launch the new blueprint wizard
Click the build a new blueprint button:
5
Complete general details for the blueprint
Enter general details for this blueprint:
Available fields are summarised below:
Field
Summary
6
Confirm general details
Click the create button to confirm general details. For example:
7
Configure the blueprint manifest
The manifest page is where you configure which process flows and resources to include in this blueprint:
First, choose which process flows to include. For example:
When a process flow is selected, the last deployed version is added.
As you select process flows, any associated resources are added to the manifest. For example:
8
Review & update the blueprint manifest
Review the updated manifest page. By default, all resources needed for each selected process flow will be included; however, you can add more resources if necessary.
Changes to this page are saved as a draft automatically.
9
Publish the blueprint
If you're ready to make this blueprint available in your private marketplace, click the publish button at the top of the manifest. For example:
When a blueprint is published, it is queued for upload to your private marketplace, and a notification is generated upon completion.
To prevent timing conflicts, an 'update in progress' banner is displayed at the top of the manifest for the duration of the publish process. For example:
During this time, the blueprint is locked - it can't be changed or installed until the upload is complete. Once the upload is complete, the blueprint becomes available in your private marketplace.
Publishing a new blueprint makes it , so it becomes available to install from your private marketplace - it does not deploy anything automatically.
Version
When a blueprint is published for the first time, version 1 (v1) is generated. If the blueprint is subsequently updated and re-published, the version number is incremented. The first version is always set to be the active, version. For more information, please see About blueprint versions.
The ellipsis icon provides access to the following options:
View installs. View and manage installations of this blueprint for your 'child' companies. From here, you can see where the blueprint is installed and promote an update to multiple companies. For more information, please refer to Rolling out blueprint updates.
Open draft. Create a draft manifest and update the blueprint. For more information, please refer to Updating a private blueprint.
Delete. Remove this blueprint from your private marketplace. Note that this does NOT remove or disable associated process flows that may already be deployed.
In this stage, we add a new SSO provider in Patchworks using your PingOne issuer ID (obtained in the previous stage) as the base URL. This generates a set of URLs that we'll go on to apply in PingOne.
Step 1
In a new browser tab or window, log into the Patchworks dashboard and select my company admin from general settings:
If you don't see this option, it's most likely that your user account is not associated with administrator permissions. In this case, please contact your system administrator.
Step 2
Click the PingOne button:
Step 3
Paste the issuer ID for your new PingOne app (copied at the end of the previous stage) into the base URL field but remove the /as characters from the end:
It's important to remove the /as characters from the end of the issuer ID. For example:
https://auth.pingone.eu/3c2eca2e-fc6e-4509-8154-68d93a9dbdf3/as would be entered as:
https://auth.pingone.eu/3c2eca2e-fc6e-4509-8154-68d93a9dbdf3.
Step 4
Click the create button to confirm.
Step 5
A PingOne provider is added - click this entry:
...you'll see that three Patchworks URLs have been generated - for example:
These URLs are needed to complete your PingOne setup in the next stage. For reference, these are:
Patchworks URL
PingOne usage
Initiate sign-in url
Initiate Login URI
Callback url (auth url)
Redirect URIs
Logout url
Not required for PingOne
Note that URLs shown in our screenshots are for a development environment -dev.app.wearepatchworks.com. Yours will always be for a production environment -app.wearepatchworks.com.
Step 6
Optionally, you can click the edit option here and set a specific name for this implementation:
This isn't mandatory but using specific names can be useful if you're adding multiple implementations of the same type. Remember to save your change if you do update the name.
Step 7
Save changes.
Step 8
Leave this page open and switch back to PingOne for the next stage.
Stage 3: PingOne - configure app
In this stage, we configure your new Patchworks app in PingOne. As part of this setup, we will provide URLs generated by Patchworks, at the end of the previous stage.
Step 1
Back in PingOne, select the configuration tab:
Step 2
Edit settings, then move down to the redirect URIs field and paste the callback URL value from your PingOne provider setup in Patchworks:
When copying URLs from your Patchworks provider details, click anywhere on the required link to copy it to your clipboard:
Step 3
Set token endpoint authentication method to client secret post:
Step 4
Move down to the initiate login URI field paste the initiate sign-in URL value from your PingOne provider setup in Patchworks:
Step 5
Save your changes and go to the next stage.
In this stage, we take client credentials generated in PingOne, apply them to our PingOne provider setup in Patchworks, and enable this SSO implementation.
Step 1
Still in PingOne, scroll to the top of the configuration page and toggle the 'enable' option (to the right of the app name) to the on position:
Step 2
A little further down, you'll see client id and client secret details - copy the client id:
Step 3
Switch to Patchworks and select the edit option for your PingOne provider setup:
Step 4
Paste the client id and then repeat the copy/paste for the client secret value:
Step 5
Toggle the enable option to on:
The SSO implementation won't be operational until this setup is enabled.
Step 6
Save changes:
Stage 5: PingOne - define scopes
In this stage, we define permissions (scopes) for the connection between PingOne and Patchworks.
Step 1
Still in PingOne, select the resources tab at the top of the page:
Step 2
Edit scopes and make the following selections:
email
offline access
profile
For example:
Step 3
Save changes to complete the setup. When you're ready you can go on to assign groups/users who can access Patchworks. This is standard PingOne functionality that isn't covered here.
Stage 6: Test the connection
To quickly test that a successful connection has been made between Patchworks and PingOne, switch back to the Patchworks dashboard, and copy the initiate sign-in URL value:
Now log out of Patchworks and paste the initiate sign-in URL value into your browser - this should log straight into the Patchworks dashboard.
Your Azure AD / Entra administrator requires a Patchworks account with administrator permissions to complete this setup.
This guide details the setup required to integrate Patchworks with Azure AD / Entra. For clarity, the setup is documented in five stages:
In this stage, we add a new SSO provider in Patchworks using your Azure AD / Entra tenant ID . This generates a set of URLs that we'll go on to apply in Azure AD / Entra.
Step 1
In a new browser tab or window, log into the Patchworks dashboard and select my company admin from general settings:
If you don't see this option, it's most likely that your user account is not associated with administrator permissions. In this case, please contact your system administrator.
Step 2
Click the Azure AD / Entra button:
Step 3
Paste your Azure AD / Entra tenant ID into the base URL field:
You'll find the tenant ID for your organisation in the Azure AD / Entra admin portal, under identity | overview.
Step 4
Click the create button to confirm.
Step 5
An Azure AD / entra provider is added - click this entry:
...you'll see that three Patchworks URLs have been generated - for example:
These URLs are needed to complete your Azure AD / Entra setup in the next stage. For reference, these are:
Patchworks URL
Azure AD / Entra usage
Initiate sign-in url
Branding & properties | Home page URL
Callback url (auth url)
App registration | Redirect URIs
Logout url
Not required for Azure AD / Entra
Note that URLs shown in our screenshots are for a development environment -dev.app.wearepatchworks.com. Yours will always be for a production environment -app.wearepatchworks.com.
Step 6
Optionally, you can click the edit option here and set a specific name for this implementation:
This isn't mandatory but using specific names can be useful if you're adding multiple implementations of the same type. Remember to save your change if you do update the name.
Step 7
Leave this page open and switch to your Azure AD / Entra admin portal for the next stage.
Stage 2: Azure AD / Entra - add new app registration & apply URLs
In this stage, we register a Patchworks app in the Azure AD / Entra admin portal and apply Patchworks URLs generated for this provider at the end of the previous stage.
Step 1
In your Azure AD / Entra admin portal, navigate to identity | app registrations and select the new registration option:
Step 2
Enter a name for this registration (we recommend Patchworks or similar):
Step 3
Move down to the redirect URI (optional) section and set the platform to web:
For the URL, paste the callback URL value from your Azure AD / Entra provider setup in Patchworks.
When copying URLs from your Patchworks provider details, click anywhere on the required link to copy it to your clipboard:
Step 4
Click register:
Step 5
Select branding & properties from the navigation menu. For the home page URL, paste the initiate sign-in URL value from your Azure AD / Entra provider setup in Patchworks:
When copying URLs from your Patchworks provider details, click anywhere on the required link to copy it to your clipboard:
In this stage, we take client credentials generated in Azure AD / Entra, apply them to our Azure AD / Entra provider setup in Patchworks, and enable this SSO implementation.
Step 1
Still in the Azure AD / Entra admin portal, select overview from the navigation bar, then copy the application (client) ID:
Step 2
Switch to Patchworks and select the edit option for your Azure AD / Entra provider setup:
Step 3
Paste the application (client) ID into the client ID field:
Step 4
Back inthe Azure AD / Entra admin portal, select certificates & secrets from the navigation bar and then select new client secret:
Step 5
Enter a description to identify this secret, set the expiry according to your organisational policies and click add:
Step 6
Copy the value for the new secret:
Step 7
Switch to Patchworks and paste the secret into the client secret field:
Step 8
Toggle the enable option to on:
The SSO implementation won't be operational until this setup is enabled.
Step 9
Save changes:
Stage 4: Azure AD / Entra - API permissions
In this stage, we define the required API permissions for the new Azure AD / Entra app.
Step 1
Switch back to the Azure AD / Entra admin portal, select API permissions from the navigation bar, then select add a permission:
Step 2
Select Microsft Graph, then delegated permissions:
Step 3
Add the following openid permissions:
email
offline access
openid
profile
For example:
Stage 5: Test the connection
To quickly test that a successful connection has been made between Patchworks and Azure AD / Entra, switch back to the Patchworks dashboard, and copy the initiate sign-in URL value:
Now log out of Patchworks and paste the initiate sign-in URL value into your browser - this should log straight into the Patchworks dashboard.
Your Okta administrator requires a Patchworks account with administrator permissions to complete this setup.
This guide details the setup required to integrate Patchworks with Okta. For clarity, the setup is documented in three stages:
In this stage, we add a new SSO provider in Patchworks using your Okta base URL. This generates a set of URLs that we'll go on to apply in Okta.
Step 1
Log into the Patchworks dashboard and select my company admin from general settings:
If you don't see this option, it's most likely that your user account is not associated with administrator permissions. In this case, please contact your system administrator.
Step 2
Click the Okta button:
Step 3
When prompted, enter the base URL for your Okta account.
This is the first part of the URL that you use to access your Okta dashboard - for example:
https://wearepatchworks.okta.com/. For our working example, the base URL is:
https://trial-6142540.okta.com/.
Step 4
Click the create button:
Step 5
An Okra provider is added - click this entry:
Step 6
You'll see that three Patchworks URLs have been generated - for example:
Note that URLs shown in our screenshots are for a development environment -dev.app.wearepatchworks.com. Yours will always be for a production environment -app.wearepatchworks.com.
Step 7
Optionally, you can click the edit option here and set a specific name for this implementation:
This isn't mandatory but using specific names can be useful if you're adding multiple implementations of the same type. Remember to save your change if you do update the name.
Step 8
Leave this page open and switch to another browser tab for the next stage.
Stage 2: Okta - add Patchworks app & apply URLs
In this stage, we create a new app for Patchworks in Okta. As part of this setup, we will provide URLs generated by Patchworks, at the end of the previous stage.
Step 1
Access Okta adminfor your organisation:
Step 2
Choose to add an app to use single sign-on:
Step 3
Choose to create new app:
As an Okta administrator, you'll likely have your own shortcut/route to access this option - feel free to use these instead.
Step 4
Select OIDC - OpenID Connect as the sign-in method:
Step 5
Select web application as the application type:
Step 6
Click next to access the New Web App Integration page:
Step 7
Update the following fields on this page (for URLs, you should switch back to the Patchworks dashboard to copy/paste values):
Field
Summary
Name
We suggest Patchworks or similar.
Logo
Optionally, you can upload a logo. A selection of Patchworks logos is available beneath this table.
Sign-in redirect URIs
Paste the callback url from your Okta provider details in Patchworks (click once in the callback url field to copy the url to the clipboard)
Sign-out redirect URIs
Patchworks logos
Right-click and save the desired logo with a .png file extension.
Step 8
Save changes.
Step 9
On the same page, move back up to general settings and select edit:
Step 10
Move down to the login section and update fields as detailed below:
Field
Required setting
Login initiated by
Either Okta or App
Application visibility
Display application to users
Initiate login URI
Paste the initiate sign-in url from your Okta provider details in Patchworks (click once in the initiate sign-in url field to copy the url to the clipboard).
For example:
Step 11
Save your changes.
At this point, you may wish to assign a test user to try out the app once you've finished.
In this stage, we take client credentials generated in Okta, apply them to our Okta provider setup in Patchworks, and enable this SSO implementation.
Step 1
Still on the New Web App Integration page in Okta, scroll to the client credentials section - you'll see client id and client secret details:
Step 2
In Patchworks, select the edit option for your Okta provider setup:
Step 3
Copy and paste client id and client secret values from Okta, into correlating Patchworks fields:
Step 4
Toggle the enable option to on:
The SSO implementation won't be operational until this setup is enabled.
Step 5
Save changes:
Any assigned users in Okta should now see a Patchworks app in their Okta dashboard, ready for use:
Resource
Notes
All connectors used in the process flow are installed without instances.
If you install an process flow which includes a connector that you have already installed from the , a fresh copy of that connector is added alongside the existing one. You can then decide which one to use.
All scripts defined in are installed and deployed, ready for use.
All cross-reference lookups defined as are installed and ready for use.
Browsing process flows
Having selected the process flows option from the marketplace, you can browse and install prebuilt process flows.
Process flows are displayed as tiles over a series of pages, which you can step through using page numbers at the bottom of the marketplace. Each process flow includes a visual summary of its component parts:
Here, the following details are shown for the process flow:
Resource
Notes
Name & description
The process flow name and description.
Date added to marketplace
The date that the process flow was uploaded to the marketplace.
Included connectors
Logos for connectors included in the process flow - i.e. connectors to be installed if you choose to install this process flow.
Viewing a process flow
To see a read-only view of a process flow before it's installed, click the view button:
Here you can see the process flow, with a breakdown of its components:
Installing a process flow
To install a process flow, click the install button:
The process flow is queued for installation and can be found in your own process flows list soon after.
Depending on the process flow and your existing setup, you may need to add instances for newly installed connectors and confirm endpoint details for connection shapes. For more information please see Installing a prebuilt process flow.
Related information
For all information about working with process flows (including how to build your own), please see our Process flows section.
The company insights page is designed to help you understand how your process flows are performing, and resource usage. At a glance, you can see which process flows are most heavy on resources, drilling down to performance for connectors and shapes that are included within those process flows:
Paste the logout url from your Okta details in Patchworks (click once in the logout url field to copy the url to the clipboard).
Assignments
Assign people and groups from your organisation who require access to the Patchworks dashboard.
Need to know
Company insights data is loaded at 1 a.m. every morning. This means that data for the current day will not be fully populated until 1 a.m. the following day.
Understanding the company insights page
Key areas to consider on the company insights page are marked below:
These areas are summarised below:
Item
Summary
1
Subscription information
Your Patchworks subscription is displayed as a button - click this to view your allowances, with access to more information on subscription tiers:
Allowances shown are for the current company profile. If you operate under an 'annual billing' agreement, the allowances shown here will be those available for the current company profile, multiplied by 12.
2
Monthly usage date selector
Choose a time period to analyse:
All subsequent data displayed is for the selected period. The selection here also determines how analysis is shown on the .
3
If you manage multiple company profiles, you'll see insights for your own (parent) company profile by default. You can also use this dropdown field to view aggregated insights for all your linked companies.
4
Performance snapshot panel
The snapshot panel provides summary metrics for the overall performance of your company's process flows, connectors used in process flows, and shapes used in process flows, for the selected month.
These metrics are summarised below:
Metric
Summary
Data usage
The aggregated size of all payloads that leave each shape in a process flow - these are known as payloads out.
Operation usage
The total number of operations completed. For more information about how operations are calculated please see .
If you manage multiple company profiles, these totals will vary, depending on how the managed company selector is set. For more information, see Managed company insights.
The data usage value shown here is the same as displayed in the left-hand navigation bar. If you notice a difference occasionally, this is most likely due to caching; values in the navigation bar are cached, but those on the main insights page are not. If this happens, you should work from the values shown on the insights page (caching will resolve itself in due course).
If you operate under a 'powered by' agreement, usage bars will always show values associated with the parent company only, irrespective of whether the managed company selector is set for parent company, managed companies, or parent+managed companies.
Data type selectors
You can view insights for process flows, connectors used in process flows, and shapes used in process flows (for the selected month) - click the required selector tab for whichever of these you want to view:
Changing the selection here updates all metrics and analysis for the new data type.
Combination chart
The combination chart shows aggregated metrics for:
Received operations
Sent operations
CPU hours
Payload sizes
For example:
Chart display
Chart data is broken down differently, depending on how the monthly usage date selector is set at the top of the page:
Chart interactions
You can interact with this chart in several ways:
Data breakdown panel
Beneath the combination chart, you'll find a breakdown of items (process flows, connectors, or shapes) included in summary metrics.
Process flow data
When process flow data is selected, you'll see a list of process flows that have been run within the selected month:
For each entry, you can see the process flow name, CPU time used, the number of times used (i.e. run), data usage, and operations usage.
Connector data
When connector data is selected, you'll see a list of connectors that have been used within the selected month:
For each entry, you can see the connector name, CPU time used, the number of times used, data usage, and operations usage.
To view more details for an entry, click the associated 'view' icon - here you'll see a breakdown of the specific connector endpoints and instances that were used (in the selected month):
Shape data
When shape data is selected, you'll see a list of shapes that have been used in process flows, within the selected month:
For each entry, you can see the shape name, CPU time used, the number of times used, data usage, and operation usage.
Tracked data graph
The tracked data chart provides a visual representation of records that have been tracked for the selected time period:
You can interact with this chart in several ways:
Managed company insights
If you manage multiple company profiles, you'll see a selector at the top of the page, defaulting to parent company (i.e. your company):
You can use this to view aggregated insights for your managed companies. For example:
Having selected this option, you'll see a snapshot panel with aggregated totals for your linked companies, followed by usage breakdown for each company that's linked to your profile.
Alternatively, select the parent+managed companies option to include your own (parent company) usage in the aggregated totals. For example:
In this case, the company breakdown includes totals for the parent company, followed by managed companies.
For organisations with an annual billing agreement, an annual usage section is displayed at the top of the insights page, showing cumulative data and operations usage. For example:
By default, you'll see usage totals since the start of your billing cycle, but you can set a custom date range if needed:
Additionally, profiles associated with an annual billing agreement will see a this year summary in the navigation sidebar (instead of this month). For example:
Any labels defined for your company profile are available for selection.
Help guide
If available, enter a link to a help guide for this blueprint.
Post-install default
Select what action (if any) should be shown to users as the default whenever this blueprint is installed manually:
None. The blueprint is installed, but the associated process flows are not deployed.
Package flows. The blueprint is installed and the associated process flows are added to a new package, ready for manual deployment to virtual environments.
Package and redeploy. The blueprint is installed and the associated process flows are redeployed wherever they currently exist - i.e. to any child companies (and any virtual environments) where this blueprint is presently installed.
When someone chooses to , they can change this option. All you're setting here is what the default setting will be.
Any caches and cache keys defined in add to cache shapes are added. These are 'clean' caches (i.e. with no associated data), ready for use.
Created
The name of the company that created this process flow.
The number of connectors included in this process flow - i.e. connectors to be installed if you choose to install this process flow.
The number of custom scripts included in this process flow - i.e. scripts to be installed if you choose to install this process flow.
The number of steps in the process flow - i.e. the number of shapes after the initial trigger.
The number of cross-reference lookup tables included in this process flow - i.e. cross-reference lookups to be installed if you choose to install this process flow.
Data usage is calculated by aggregating the size of payloads that leave each shape in a process flow - these are known as payloads out.
In any process flow, data is received and passed from one shape to the next. Different shapes handle their incoming payload(s) in different ways - in some cases, data simply passes through (data in is the same as data out) but in others, data is manipulated and changed.
Understanding how these payloads are aggregated provides a clearer picture of your overall data usage.
What is a payload out?
A payload is the data generated/processed during the execution of any shapes within a flow. We refer to the payload out when it leaves that shape. This could be via any of the mechanisms below:
Mechanism
Summary
How data usage is calculated
To calculate data usage, all payload out sizes (from each shape in a process flow) are aggregated. Here's how this works:
Considerations for your data usage
Typically, the size of a payload that goes into a process flow shape is the same as the payload out size - payloads are not modified unless your flow includes actions that are designed to do this.
The table below summarises process flow shapes and their ability to change the size of incoming payloads:
Shape
Change size?
Notes
Examples
The examples below show how data usage can be affected by different process flow shapes.
Patchworks infrastructure
Introduction
A cutting-edge iPaaS platform requires a robust, versatile infrastructure that scales with its customers. The Patchworks infrastructure is built on Kubernetes, a technology that has revolutionised how we deploy, manage, and scale our applications:
Data is sent/received via an event, webhook or Patchworks API call.
Yes
When receiving data, the payload out will reflect the volume of data received from this connection request.
When sending data, the payload out will be the same as the incoming payload UNLESS you choose to save response as payload (in which case the payload out is - typically - smaller than the incoming payload).
No
If set to filter or track & filter, a de-dupe shape may reduce the size of the incoming payload by removing duplicate items.
If set to track, the incoming payload simply passes through for tracking - the payload out will always be the same as the incoming payload.
A de-dupe shape will never increase the size of the payload out.
Yes
If a filter removes data from an incoming payload, the payload out will be smaller than the incoming payload. A filter will never increase the size of the payload out.
No
The incoming payload is batched into multiple, smaller batches but the aggregate size of the payload out for those batches is always equal to the incoming payload size.
Yes
The payload out will reflect the volume of data loaded from the cache.
Yes
A straightforward like-for-like mapping between two systems will not affect the size of the payload out. However, if are applied the size of the payload out may change slightly - for example, prefix, suffix, format date and script transforms.
Typically, any size variations from mapping transformations are small.
No
The payload out is always the same as the incoming payload.
Yes
When an incoming payload hits a route shape, your defined conditions are checked and a payload out is created for each defined route.
If your route conditions exclude items in the incoming payload from progressing down any routes then the aggregate size of payloads out will be smaller than the incoming payload.
Yes
If you configure this shape with a manual payload then the payload out is likely to differ from any incoming payload.
If no manual payload is specified then the payload out is always the same as the incoming payload.
Yes
A custom script might increase or decrease the size of the payload out.
No
The payload out is always the same as the incoming payload.
Yes
The incoming data is split at a defined data element, so only that element progresses to the next step - i.e. the payload out is likely to be smaller than the incoming payload.
No
The incoming payload simply passes through for tracking - the payload out will always be the same as the incoming payload.
A track data shape will never increase the size of the payload out.
Patchworks API call
Data is received from or sent to an API call.
Connector shape
Data is received from or sent to a Patchworks connector.
Other shapes
Data is processed within any shape - for example, by a custom script (script shape or transform function), mapping payloads from one structure to another (map shape), or routing payloads down multiple branches (route shape).
The payload out is always the same as the incoming payload.
(1) Identify interactions
Every time a shape in your process flow performs a manipulation, moves data or sends/receives data between systems, an interaction occurs. This could be an API call, a file upload, or any other data transfer/manipulation.
(2) Measure payload sizes
For each interaction, the size of the payload out is measured in megabytes.
Only the actual payload is considered - metadata, headers, and other non-payload data are NOT considered when calculating the payload out size.
(3) Aggregate payload sizes
All payload sizes are aggregated to calculate the total data usage.
In the simplest of flows, a connector shape receives a 1MBpayload, so the first payload out is 1MB.
The map shape receives this as its incoming payload. There are no field transformations so the data doesn't change - the second payload out is 1MB.
The final connector shape receives this as its incoming payload to be sent into the associated system. We have NOT set the save response as payload option to on, so the
Here, a connector shape receives a 1MBpayload, so the first payload out is 1MB.
The de-dupe shape receives this as its incoming payload and filters out all duplicate records, reducing the payload size. The next payload out is 0.75MB.
The map shape receives this as its incoming payload. There are no field transformations so the data doesn't change - the next
Here, a connector shape receives a 1MBpayload, so the first payload out is 1MB.
This payload is added to a cache, and the next payload out is 1MB. This payload is passed to a route shape with conditions that send half the payload down one route and half down the other - resulting in 2 x 0.5MB payloads out.
Here, a connector shape receives a 1MBpayload, so the first payload out is 1MB.
This payload is added to a cache, and the next payload out is 1MB. Then we load cache data from an existing company cache which is 50MB, so the next payload out is 50MB.
Data moves between systems - for example, CSV files or image files.
A breakdown of each process flow, connector, or shape (depending which data type is selected) that's included in aggregated totals for the selected month.
If your organisation controls access to applications via SSO using an enterprise identity management system, you can configure your provider in general settings. The following providers are supported:
The aggregate total for the payload out size for all three shapes is 3MB.
payload out
is
0.75MB
. The
flow control
shape receives this as its incoming payload and batches it into 10 payloads for onward processing. The next
payload out
is
10 x 75K
.
The second connector receives all 10 payloads to be sent into the associated system. We have NOT set the save response as payload option to on, so the payload out is 10 x 75K. Finally, all 10 payloads pass through the de-dupe shape for tracking only. The payload out is 10 x 75K.
The aggregate total for the payload out size for all shapes is 4.75MB.
For route 1, the first 0.5MB payload passes through a track data shape and the payload out is 0.5MB. The map shape receives this as its incoming payload and there are no field transformations so the data doesn't change - the payload out is 0.5MB. The final connector receives this as its incoming payload to be sent into the associated system. We have NOT set the save response as payload option to on, so the payload out is 0.5MB.
For route 2, the first 0.5MB payload is received by the map shape - there are no field transformations so the data doesn't change - the payload out is 0.5MB. The final connector receives this as its incoming payload to be sent into the associated system. We have NOT set the save response as payload option to on, so the payload out is 0.5MB.
The aggregate total for the payload out size for all shapes is 5.5MB.
The script shape receives this as its incoming payload and runs - it doesn't do anything that affects the payload size so the next payload out is 50MB.
The map shape receives this as its incoming payload. There are no field transformations so the data doesn't change - the next payload out is 50MB.
The final connector receives this as its incoming payload to be sent into the associated system. We have NOT set the save response as payload option to on, so the payload out is 50MB.
The aggregate total for the payload out size for all shapes is 202MB.
Microservices are used to build the Patchworks platform - small, independent services that communicate with each other, allowing for flexibility, scalability, and easier maintenance.
API first is key for powerful integrations. Our next-generation dashboard is driven by powerful APIs which means we can integrate with any other API simply and seamlessly.
Cloud-native development facilitates our microservice architecture, Kubernetes deployments, DevOps infrastructure as code, and much more!
Headless is exactly what you'd expect for an API-first platform. The Patchworks backend is built with our own API, which is then consumed by the dashboard for general use.
Kubernetes pod and node auto-scaling Ensure that integrations run consistently, even in the busiest times. See our auto-scaling page for more information.
We use AWS RDS for all critical databases. Our databases have full redundancy with one ‘read’ and one ‘write’ copy of each.
Each database copy is hosted in a separate availability zone so, in the unlikely event of a failure in one zone, we can fall back to the other.
Real-time logs (via web sockets) can be viewed while a process flow runs, with visibility of request, response and payload information at every step.
Logs are retained for one month for retrospective problem-solving.
Webhooks, events, and inbound API requests can all be tracked through the Patchworks Dashboard - you don’t need to be an engineer to figure out when/where execution errors occur.
We manage all API updates for our library of prebuilt connectors.
We take care of all supported authentication mechanisms (OAuth, token, API key, etc.).
We've removed all the complexity when it comes to building and maintaining new integrations.
Our multi-tenant architecture means that customers have the benefits of shared software and infrastructure, secure in the knowledge that each customer's data is isolated and invisible to other tenants.
Multi-tenancy provides a much faster solution, since we only search one set of data rather than everything - all database operations and secret storage is per-tenant.
Multi-tenancy allows flexibility for change - if necessary we can 'lift and shift' a tenant to a new database, or to a faster region, or even to a completely different cloud provider in a different continent!
Infrastructure updates are made via IaC (Infrastructure as Code).
Infrastructure updates are peer-reviewed and authorised before being merged.
All production code flows through development and staging review cycles before release to production.
Every release must pass both automated and hands-on testing by our QA team.
Product penetration testing is performed annually by an external, CREST-accredited organisation.
Our Kubernetes nodes live in private subnets.
All key ingresses are IP whitelisted.
We adopt a 'least privilege' model for our development team, and also for users of our AWS and Kubernetes infrastructure.
All key business systems must be accessed via a VPN
All staff use LastPass to generate and store strong passwords - 2FA access to LastPass is mandated.
Access is managed via role-based permissions, so only authorised users can access integrations and data for their company profile(s).
Audit logs provide a complete history of all user account activity, including Patchworks users.
Users always control their own passwords - password resets are never performed on behalf of other users.
Different organisations have different needs when it comes to utilising the Patchworks dashboard - from minimal features required to perform specific tasks, all the way through to advanced functionality for building complex data flows in-house.
Our Core subscription tiers ensure that there's something to suit everyone. Information on this page details available subscription tiers and associated information.
Having , its associated features and allowances are available to your organisation. Each user within your organisation is assigned a which determines if/how they can access these features.
Available core subscription tiers
The table below summarises available dashboard features and feature allowances for each Core subscription tier.
Tier
Summary
Core subscription tier allowances
The table below summarises feature access and allowances for each Core subscription tier.
Feature ↓
Trial
Blueprint store
Standard
Pro
Custom / Enterprise
When do monthly/daily allowances refresh?
Allowance type
Summary
Blueprint store tier summary
The blueprint store tier is for users who only need dashboard access to run . These blueprints are built to perform specific tasks and as such, access is limited to features directly associated with purchased blueprints. The table below summarises allowed feature access for users on the blueprint store tier.
Feature
Allowed options
Advanced features
Advanced features are available on the , or can be added for users via a . These features are listed below.
Feature
Item
Core subscription tier bolt-ons
The table below summarises bolt-ons that can be purchased and added to .
Bolt-on
Applicable tiers
Summary
About the partner features bolt-on
The partner features bolt-on allows you to . An allowance is provided for the number of companies created for given subscription tiers.
About the callback bolt-on
The callback bolt-on provides access to and the , allowing you to send an API request which initialises a process flow and returns data in a real-time, synchronous call.
This feature utilises a callback queue to ensure that data is returned as a priority. All customers using the callback feature access the same callback queue, so performance depends on the complexity of your process flows and general platform load. Please see our page for more information on how this works.
For faster callback times, a dedicated callback queue can be purchased for your company. Please for details.
Callback limits
The number of callback requests permitted per minute is determined by your core subscription tier. Given the nature of callbacks, soft and hard limits apply for requests:
Soft limit
If a callback request exceeds your allowance up to and including the hard limit (see below) then processing continues normally, subject to any overage agreement that's in place.
Hard limit
A hard limit of 240 applies to all company profiles. If the number of callback requests made per minute exceeds the associated subscription tier allowance by 241 or more, the request fails with a 429 too many requests response.
About the tracked data extension bolt-on
By default, tracked data remains available for interrogation (via the ) for 15 days. The tracked data extension allows you to increase this number of days.
The maximum number of days that can be added to the default is 75 (so a total lookback period of 90 days).
It's important to note that any increase is not retrospective - your extended lookback starts to increment by one day, each full day after the extension is added. For example, if you add a tracked data extension of 10 days on the 1st of the month - giving a lookback of 25 days in total - the full 25-day lookback becomes available 10 full days later:
Day
Number of lookback days available
How do I purchase a subscription tier or bolt-on?
Anyone can sign up for a new Patchworks via our . When your 15-day trial period ends, you can contact the Patchworks Sales team to purchase the required subscription. You can do this via our , or our :
If you have come to Patchworks via an agency/partner, please contact them to arrange your preferred subscription.
How can I check my subscription allowances?
To view all allowances for your subscription, - you'll see your current subscription tier in the top right-hand corner. Click this to view all associated allowances:
For more information about this option please see our w page.
How can I check the status of my connector & process flow allowances?
Subscription tiers are associated with different allowances for the number of deployed connectors, and the number of deployed process flows.
For allowance purposes, a 'deployed' process flow is a process flow that is both deployed and enabled. A 'deployed' connector is a connector that is in use by a 'deployed' process flow.
To view the number of 'deployed' connectors and the number remaining in your subscription tier allowance, select connectors and instances from the left-hand navigation menu - your allowance status is shown in the header of the manage connectorspage:
To view the number of 'deployed' process flows and the number remaining in your subscription tier allowance, select process flows from the left-hand navigation menu - your allowance status is shown in the header of the manage your flowspage:
Professional tier users have full access to all standard and dashboard features. - if required, can be added to extend these allowances.
Custom
Custom tier users have full access to all standard and dashboard features. .
Full access
Full access
No access
Full access
Full access
(i.e. connectors used in enabled & deployed process flows)
2
Read-only access to purchased blueprint connectors
2
4
Custom
Unlimited
Unlimited
Unlimited
Unlimited
Unlimited
2
10
20
Custom
1
10
10
20
Starting at 30
(per month)
10,000
150,000
250,000
500,000
Custom
Full access
No access
Full access
Full access
Full access
(per minute)
240
240
240
Starting at 240
(per minute)
2
0
120
Starting at 120
(per minute)
2
0
0
Starting at 120
Full access
No access
Full access
Full access
(per month)
100
100
500
1000
Starting at 1000
(per day)
5
5
5
5
5
2
2
2
Starting at 2
Edit the trigger schedule for existing process flows
Process flows (shapes) - connector
Edit instance
Edit existing parameters & filters
Process flows (shapes) - filter
Edit existing filters
Process flows (shapes) - route
Edit existing condition filters
Process flows (shapes) - add to cache & load from cache
Can use if included with process flow(s)
Cannot create new caches
Cannot delete caches
Process flows (shapes) - de-dupe
Can use if included with process flow(s)
Cannot create new data pools
Cannot delete data pools
Patchworks API
Can use if required by purchased blueprint(s)
Webhooks
Can use if included with process flow(s) - cannot add new webhooks
Event connectors
Can use if included with process flow(s) - cannot add new event connectors
Custom scripts
Can use if included with process flow(s) - cannot add, edit, delete or deploy scripts
Cross reference lookups
Edit cross reference values in any cross reference lookups associated with purchased blueprint(s)
Connector builder
No access
Events
Patchworks API
10 process flows
standardprofessionalcustom
Add ten more process flows to current deployed process flows allowance.
60 webhooks per minute
standardprofessionalcustom
Add 60 webhooks per minute to an existing allowance.
standardprofessionalcustom
Add 120 callbacks per minute to an existing allowance.
standardprofessionalcustom
Create linked companies.
Flow concurrency limit
standardprofessionalcustom
Increase the number of process flows that can be run concurrently.
Cache memory (MB)
standardprofessionalcustom
Increase the size of caches that can added. The default allowance is 50MB.
Inbound API rate limit
standardprofessionalcustom
Increase your rate limit for the Patchworks API.
standardprofessionalcustom
Add a given number of days to an existing allowance.
AI requests
standardprofessionalcustom
Increase the number of AI requests allowed per day.
Virtual environments
standardprofessionalcustom
Increase the number of allowed virtual environments.
5th
19
6th
20
7th
21
8th
22
9th
23
10th
24
11th
25
Trial
Having registered for a Patchworks account your free trial starts with full access to all dashboard features for 15 days.
Blueprint Store
Applies for customers who access the Patchworks dashboard purely to use a particular blueprint - i.e. there's no requirement to install additional connectors/resources, build/update process flows, etc. With some exceptions, blueprint store user access is read-only.
Your allowance resets at the start of every new calendar month. You have access to your full balance from the first minute of the month until the final minute of the last day in that month. For example: March 1st, 00:00 to March 31st, 23:59.
Daily
Your allowance resets at the start of every new day. You have access to your full balance from the first minute of the day until the final minute of the same day. For example: March 1st, 00:00 to March 1st, 23:59.
Marketplace
Access restricted to viewing/updating connectors included with purchased blueprint(s).
Connectors
Add new instances for existing connectors
Edit existing connector instances
Process flows (general)
Run logs
Edit existing process flow settings
Edit existing process flow variables
Deploy existing process flows
Enable & disable labels for existing process flows
Add & delete labels for existing process flows
Add & delete email notifications for existing process flows
This page details roles and permissions for key areas of the Patchworks platform. User accounts can be associated with one of four possible roles:
Administrator
Manager
User
Read-only
The tables summarise dashboard access by role. It's important to be aware that available features are determined by your . So, although a user's role might be associated with permissions to access a given feature, that feature is only available if it's included in the active subscription tier - think of it as 'tier trumps role'. For example:
All permissions refer to entitiesassociated with your own company profile. If you manage multiple company profiles, please see our section for more information.
Roles determine access to create/read/update/delete functionality. There is nothing in the setup or execution of process flows that's tied explicitly to a user. For example, when a connector is authenticated, we don't check anything about who created it.
How are roles assigned to users?
When someone registers for a Patchworks account, they are assigned to the administrator role, automatically. This user can go on to and/or as needed.
Typically, there is one administrator for each organisation. If you require more than one user with this role, please .
Roles & permissions summary
The tables below summarise access by role for key tasks within the Patchworks dashboard:
Company profile
Company permissions refer to features that are available from settings > my company profile.
Task
Allowed roles
Company admin
Company admin refers to features that are available from settings > company admin.
Task
Allowed roles
Company users
Company user permissions refer to features that are available from settings > my company profile > extra > users.
Task
Allowed roles
Company insights
Company insights refers to your account summary company insights page.
Task
Allowed roles
Linked companies
Permissions in this section are only relevant if you use Patchworks to manage multiple companies - i.e. you have a with one or more linked companies.
Task
Allowed roles
Marketplace
Marketplace permissions refer to features that are available from the page.
Task
Allowed roles
Private marketplaces
permissions refer to features available to work with private marketplace resources.
Task
Allowed roles
Private blueprints
Blueprint permissions refer to features that are available from the private marketplace, and the page.
Task
Allowed roles
Connectors
Connector permissions refer to features that are available from the page.
Task
Allowed roles
Connector instances
Connector instance permissions refer to features that are available from the page.
Task
Allowed roles
Process flows
Process flow permissions refer to features that are available from the page.
Task
Allowed roles
Virtual environments
Virtual environment permissions refer to features used to work with .
Task
Allowed roles
Run logs
Run logs permissions refer to features that are available from the page.
Task
Allowed roles
General settings
General settings permissions refer to features that are available from the page.
Task
Allowed roles
For my company profile permissions, see and .
Custom scripts
Custom script permissions refer to features that are available from the page.
Task
Allowed roles
Cross-reference lookups
Cross-reference lookup permissions refer to features that are available from the page.
Task
Allowed roles
Caches
Cache permissions refer to features that are available from the page.
By default, the managerrole has required permissions to create and update custom scripts
Jack is assigned the manager role
By default, the managerrole has required permissions to create and update custom scripts
Add & manage banner messages
Create a company user with a manager role
Update subscriptions for linked companies
Install marketplace connectors
Bulk update blueprint installations
Delete installed connectors
Delete connector instances
Update process flows (add/update/remove shapes)
Manage virtual environments
View run log details
View
Update custom scripts
Add & manage cross-reference values
Update existing cache details
Bob's company is associated with a standardsubscriptiontier, which permits read-only access to existing custom scripts and other advanced features
Bob can view any existing custom scripts (for example, that have been installed via blueprints), but he cannot make any changes and he cannot create his own scripts
Jack's company is associated with a professionalsubscription tier, which permits full access to custom scripts and other advanced features
Jack can view, create and update custom scripts as needed