Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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.
Patchworks is an Integration Platform as a Service (iPaaS).
Our secure, multi-language, cloud-based platform allows you to automate 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 individual requirements perfectly. However, the key to real strategic advantage is integration - establishing a frictionless exchange of data between all of your applications, in a smart way.
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 dashboard, you can add, manage and orchestrate your integrations with complete peace of mind when it comes to security and scalability.
Patchworks is an incredibly 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 we can.
Using click-and-drop process flows with automated shapes and an impressive library of prebuilt connectors (in the Patchworks marketplace), 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.
With Patchworks, you can configure and connect any of our prebuilt connectors in process flows.
But what if we don't have a prebuilt connector for an application that you need to sync? Maybe you have a bespoke, in-house system - or perhaps you want to integrate an application that's completely outside of the eCommerce arena. No problem - the Patchworks connector builder is your new best friend!
If you have technical knowledge of APIs and working with data structures, you can use the connector builder to integrate any application with REST or SOAP APIs.
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 Patchworks API to build against Patchworks from third-party systems and interact with your Patchworks process flows or services.
Custom scripting 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 element of your process flow.
See process flow canvas.
Having registered for a Patchworks account, use your credentials to log in to the Patchworks dashboard. 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: Patchworks quickstart guide.
The meaning of connector varies, depending on whether you are using process flows or services to sync data in Patchworks. Please expand the appropriate definition below.
If you need to integrate a third-party application that doesn't have a prebuilt connector in the Patchworks marketplace - and if you have technical knowledge of APIs and working with data structures - you can use the connector builder to integrate any application with REST or SOAP APIs.
For more information please see: Connector builder.
An instance is the mechanism that Patchworks uses to configure a connector for use in process flows - 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: Connectors & instances.
With Patchworks, you can install and then use instances of a range of curated, prebuilt connectors which are available from the Patchworks marketplace.
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 dashboard.
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 shapes onto a canvas, and then configuring them as required.
For more information please see: About process flows.
The canvas includes everything you need to build a process flow. Here, you drag shapes from the shapes tray, drop them onto the canvas, and then configure settings and relationships as required.
For more information please see: The process flow canvas.
When you add/edit a process flow, a set of shapes is available from the canvas. Each shape performs a specific task - for example, the trigger (schedule) 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: Process flow shapes.
Process flows include all the functionality of services and much more. You can continue to use services but if you'd like to try process flows, please contact your Customer Success Manager, or reach out to [email protected].
If you registered for a Patchworks account after July 2023, you will be using process flows automatically.
See process flow shapes.
When you are working with services to sync data in Patchworks, a system is a Patchworks integration for a third-party business system - for example, Shopify.
The concept of 'systems' is only relevant if you are using Patchworks services to sync data - it is not used in process flows.
Different organisations have different needs when it comes to utilising the Patchworks dashboard - from minimal features required to perform very 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 purchased a subscription, its associated features and allowances are available to your organisation. Each user within your organisation is assigned a role which determines if/how they can access these features.
The table below summarises available dashboard features and feature allowances for each Core subscription tiers.
The table below summarises feature access and allowances for each Core subscription tier.
The app store tier is for users who only need dashboard access to run prebuilt apps. These apps are built to perform specific tasks and as such, access is limited to features which are directly associated with purchased apps. The table below summarises allowed feature access for users on the app store tier.
Advanced features are available on the professional tier, or can be added for standard tier users via a bolt-on. These features are listed below.
The table below summarises bolt-ons that can be purchased and added to existing core subscription tiers.
Anyone can sign up for a new Patchworks trial subscription via our login page. When your 15-day trial period ends, you can contact the Patchworks Sales team to purchase the required subscription. The quickest way to do this is via our Dashboard live chat.
If you have come to Patchworks via an agency/partner, please contact them to arrange your preferred subscription.
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 connectors page:
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 flows page:
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.
The following languages are currently supported:
English
French
German
Italian
Japanese
Netherlands
Portuguese
Serbian
Spanish
This page includes video demonstrations showing different aspects of the Patchworks platform.
Our CTO, Conor Barr, demonstrates the simplicity of installing the Patchworks Shopify & Peoplevox app, and then syncing data between associated connections, seamlessly!
Our CEO, Jim Herbert, demonstrates the simplicity of installing the Patchworks Lightspeed X-Series & Shopify app, and then syncing data between associated connections, seamlessly!
A connector is the mechanism that Patchworks uses to configure a system for use in services - it's how we store your system credentials in a single, easy-to-manage place. For more information please see: .
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.
For more information please see: .
Tier | Summary |
---|---|
Feature ↓ | Trial | App store | Standard | Pro | Custom / Enterprise |
---|---|---|---|---|---|
Feature | Allowed options |
---|---|
Feature | Item |
---|---|
Bolt-on | Applicable tiers | Summary |
---|---|---|
Our CEO, Jim Herbert, shows how easy it is to build your own custom connector with the Patchworks in just 5 minutes!
Our CTO, Conor Barr, demonstrates the power of and shapes in Patchworks process flows.
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.
Process flows are a new, incredibly powerful tool that you can use to define smart, flexible flows to exchange data between connector . Process flows are built by dragging and dropping onto a , and then configuring those shapes to work in the way you need. Please take a look at our to get your bearings, and then navigate to the section of this documentation for more detailed information.
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 , that's OK - please see the section of this documentation for information that's relevant to your way of working.
Trial
Having registered for a Patchworks account your free trial starts with full access to all dashboard features for 15 days.
App store
Applies for customers who access the Patchworks dashboard purely to use a particular app - i.e. there's no requirement to install additional connectors/resources, build/update process flows, etc. With some exceptions, app store user access is read-only.
Standard
Standard tier users have full access to all standard dashboard features - advanced features are displayed but are read-only. Limits apply to the number of deployed connectors and process flows allowed - if required, bolt-ons can be added to extend these allowances.
Professional
Professional tier users have full access to all standard and advanced dashboard features. Enhanced limits apply to the number of deployed connectors and process flows allowed - if required, bolt-ons can be added to extend these allowances.
Custom
Custom tier users have full access to all standard and advanced dashboard features. Custom limits apply to the number of deployed connectors and process flows allowed.
Marketplace
Full access
No access
Full access
Full access
Full access
Deployed connectors (i.e. connectors used in enabled & deployed process flows)
2
Read-only access to purchased app connectors
2
4
Custom
Connector instances
Unlimited
Unlimited
Unlimited
Unlimited
Unlimited
Deployed process flows
2
10
20
Custom
Flow runs per minute
1
10
10
20
30 (can be increased STC)
Connector builder
Full access
No access
Full access
Full access
Full access
Inbound API
Full access
No access
Full access
Full access
Webhooks
2 per minute
30 per minute
30 per minute
120 per minute
120 per minute (can be increased STC)
Advanced features
Full access
Read-only
Read-only
Full access
Full access
Marketplace
Access restricted to viewing/updating connectors included with purchased app(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
Run existing process flow manually
Process flows (shapes) - trigger
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
Can clear existing cache(s) via cache maintenance
Process flows (shapes) - de-dupe
Can use if included with process flow(s)
Cannot create new data pools
Cannot delete data pools
Can remove single IDs via data pool maintenance
Inbound API
Can use if required by purchased app(s)
Webhooks
Can use if included with process flow(s) - cannot add new webhooks
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 app(s)
Cache
Add to cache shape
Load from cache shape
De-dupe
De-dupe shape
Data pool maintenance
Custom scripts
Script shape
Custom scripts
Advanced features
Enable advanced features
Single connector
Add one more connector to current deployed connectors allowance
10 process flows
Add ten more process flows to current deployed process flows allowance
60 webhooks per minute
Add 60 webhooks per minute to existing rate limit.
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.
Key steps from initial registration through to putting process flows live are summarised in the illustration below:
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: Registering for a Patchworks account.
If you are a Patchworks partner, you should create a company profile for each of your managed companies. Please see Registering for a Patchworks account - Patchworks partners for more information.
If your systems operate in a single country with a single currency, you probably won't need to complete any additional company setup after initial registration.
However, if you have multiple instances of a system (e.g. Shopify) to manage different locations and currencies, you will need to add a company group for each instance. For details, please see: Adding a company group.
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/services in Patchworks), or simple user permissions, (so they largely have view-only access). For details, please see Adding a company user.
To learn more about Patchworks roles and permissions, please see: About passwords, roles & permissions.
Now we're getting to the heart of Patchworks!
Connectors and instances are used to integrate third-party applications with Patchworks. For any third-party application that you wish to pull data from or push data to, you must:
Install the associated Patchworks once
Add one or more for the installed connector
You'll find a curated library of prebuilt connectors in the Patchworks marketplace. If we don't have a prebuilt connector for an application you need to sync, and you have some technical expertise in-house, you can use the Patchworks connector builder to build your own.
For more information please see: Connectors & instances.
Having installed your required connectors and added instances, you are ready to build your first process flow - this is where you define if, when, what, and how data is synced.
Process flows are built in a very visual way, by dragging and dropping automated shapes onto a canvas, then configuring them as required. For more information please see: About process flows.
Once a process flow is activated, it runs automatically as per any defined trigger shape settings. if required, you can also choose to run a process flow manually, with instant feedback and real-time logging.
As a process flow runs, you can see real-time progress from the canvas, with detailed logs generated throughout the run. Run logs can also be viewed retrospectively, so you always have full oversight of what's happened with your data.
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:
The Patchworks infrastructure is designed for resilience and scalability - utilising cutting-edge technologies and best practices to ensure that 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.
Customers who use services to sync data will see rather than process flows. If you are an existing customer and would like to upgrade to using process flows, please contact the Patchworks Sales team.
Two registration paths are available for Patchworks - whichever you choose determines how users access the platform:
Users register for Patchworks with a unique email address and password. Thereafter, these credentials are used to sign into Patchworks:
For further information, please see the Simple registration help page.
Users register for Patchworks with Google Sign-In. Thereafter, signing into Patchworks is via Google:
Google Sign-In is implemented using the OAuth (Open Authorisation) protocol.
Two versions of OAuth are available - OAuth 1.0 and OAuth 2.0. The Patchworks implementation uses OAuth 2.0.
OAuth enables users to log into an application/website (the Client/Consumer - in this case, Patchworks) using account information from another application/website (the Service Provider - in this case, Google) without ever sharing the user’s password. This is known as Secure Delegated Access.
To achieve this, OAuth uses a system of access tokens. An access token authorises temporary access to specific account information - Patchworks requests and stores the following details from Google:
UserID
Name
Email address
Avatar URL
For further information, please see the Google account registration help page.
The Google sign-in flow for a user is summarised below:
The user accesses the Patchworks login page.
The user selects Sign in with Google.
Patchworks redirects the user to the Google Sign-In page. Here, the user is informed what information they will share with Patchworks by signing in to Google.
The user enters their Google account credentials. If sign-in is successful: - The Google Authorisation Server issues an access token to Patchworks. - Patchworks requests required data from Google, presenting the access token for authentication. - Google returns the requested resources (provided that the access token is valid).
The user is returned to Patchworks and is logged into the dashboard.
Within Patchworks, user accounts are associated with a role. This role determines the level of access that users have within the Patchworks dashboard (subject to the active subscription tier). For more information please see the Roles & permissions page.
Passwords can never be viewed or accessed by users, irrespective of their role. For further information please see the Password control section.
Passwords can never be viewed or accessed by users, irrespective of their role.
Any logged-in user can change their password by selecting the Change password option associated with their avatar (in the top right-hand corner of the dashboard).
For further information please see: Changing your password.
Users associated with the client admin role can trigger a password reset for any users in their company profile, via the Patchworks dashboard. For more information please see our Triggering a password reset for another user 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.
Users can reset their password via a Forgot your password link - this link is always available at the bottom of the Sign in to Patchworks page:
Selecting this option displays a Reset Password page, where the user can enter their email address and trigger a password reset email:
The password reset email includes a link for the user to follow and reset their password.
Password reset links are valid for 24 hours. After this, another password reset must be triggered so a new link is emailed.
If a user registers their Patchworks account with Google sign-In, they won’t be aware of a ‘Patchworks password’ because they always sign in with Google credentials.
However, if a password reset is triggered for a Google sign-In user, they still receive a password reset email, which can be used to set a Patchworks password.
This does not affect the person’s Google sign-in, it just means they can choose to log in via Google or enter their email address and Patchworks password (simple sign-in).
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.
Patchworks passwords do not expire.
Users who sign in via Patchworks simple sign-in can choose to reset their password any time, from the Patchworks sign-in page.
Alternatively, users with a Client Admin role can trigger password resets for other users in their company profile.
Patchworks passwords are stored in an encrypted AWS database.
We have already noted that OAuth2 is used to authorise access to Patchworks via Google sign-in. In this scenario, Patchworks requests an access token from Google; once a token is received, it is used to request the required user information for the sign-in process.
However, OAuth2 is also used for clients who wish to access Patchworks services via a Patchworks API endpoint. In this scenario, Patchworks provides an access token to clients, which is used to authenticate API requests.
For further information please see our API help pages.
Registration type | Authentication / authorisation type | Sign-in mechanism | Sign-in process |
---|---|---|---|
Simple
Basic Auth
Username and password
User accesses the Sign in to Patchworks page. Here, they enter the email address associated with their account, and a password.
OAuth 2.0
Google sign-in
User accesses the Sign in to Patchworks page. Here they select the Sign in with Google option for redirection to the Google sign-in page.
This section includes guidance about the different paths available to register your company for a Patchworks account.
If your company has already been registered but you need a new user account, this task should be completed by your administrator via Patchworks settings.
How to create a Patchworks account
Two registration paths are available for Patchworks:
You must complete the Google registration process if you want to log in with your Google account credentials. If you provide a Google email address as part of the simple registration process, this will be associated with a Patchworks password.
This section includes information to help with whichever registration path you choose.
If you are a Patchworks partner managing multi-company profiles, please contact your Patchworks Partner Enablement Manager if you need to add a new company.
Required companies will be created and linked to your partner profile, ready for you to complete the required setup.
For more information please check our multi-company profiles section.
For Google account registration, you are directed to Google for authentication. Your account is then created with immediate access to a free trial which runs for 15 full days (ending at midnight on the 15th day).
Step 1 Access the Patchworks login page and click the register option:
Step 2 Enter your email address and click accept.
Step 3 Check your emails - you should receive a message from Patchworks almost immediately, containing a link to complete the registration process. Click this link:
...the Patchworks registration page is displayed:
Step 4 Click the sign in with Google button:
Step 5 Select the Google account that you want to use - for example:
Step 6 Check confirmation details and click continue:
Step 7 When the first Patchworks registration page is displayed, confirm/change your name and click continue:
Step 8 Complete the second part of your registration (company details) - then click continue:
Step 9 Read and accept terms and conditions, then click the create Patchworks account button:
Step 10 You are directed back to the Patchworks login page, where you can log in with the sign in with Google button:
New companies have immediate access to a free trial which runs for 15 full days (ending at midnight on the 15th day).
Registering a new company will create you as its administrat
For simple registration, you provide an email address and a password to use as login credentials for the Patchworks dashboard, followed by a few company details.
Your account is then created with immediate access to a free trial which runs for 15 full days (ending at midnight on the 15th day).
Step 1 Access the Patchworks login page and click the register option:
Step 2 Complete user details for the admin user to be associated with this account, then click continue:
The email address provided here is used to create a Patchworks admin account. When setting your password, 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 %)
If you provide a Google email address as part of the simple registration process, this will be associated with a Patchworks password. If you want to log in with your Google account credentials, you should complete the Google registration process instead.
Step 3 Complete company details for the admin user to be associated with this account, then click continue:
The email address provided here is used as the Patchworks point of contact for your company. The address defaults to the same email account that you specified for the user account in the previous step, but you can change it if necessary.
Step 4 Read and accept the Patchworks terms & conditions, then click create Patchworks account:
Step 5 Your Patchworks account is created, and you'll receive a welcome email. You can now log into the Patchworks dashboard using the email address and password that you provided.
New companies have immediate access to a free trial which runs for 15 full days (ending at midnight on the 15th day).
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.
Patchworks passwords do not expire.
Users who sign in via Patchworks simple sign-in can choose to reset their password any time, from the Patchworks sign-in page. Alternatively, users with a Client Admin role can trigger password resets for other users in their company profile.
Patchworks passwords are stored in an encrypted AWS database.
Passwords can never be viewed or accessed by users, irrespective of their role.
Any logged-in user can change their password by selecting the change password option associated with their avatar (in the top right-hand corner of the dashboard). For further information please see: Managing your own user account.
Users associated with an administrator or manager role can trigger a password reset for any users in their company profile, via the Patchworks dashboard. For more information please see our Triggering a password reset for another user 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.
Users can reset their password via a forgot your password link - this link is always available at the bottom of the sign in to Patchworks page:
Selecting this option displays a reset password page, where the user can enter their email address and trigger a password reset email:
The password reset email includes a link for the user to follow and reset their password.
Password reset links are valid for 24 hours. After this, another password reset must be triggered so a new link is emailed.
If a user registers their Patchworks account with Google sign-In, they won’t be aware of a ‘Patchworks password’ because they always sign in with Google credentials.
However, if a password reset is triggered for a Google sign-In user, they still receive a password reset email, which can be used to set a Patchworks password.
This does not affect the person’s Google sign-in, it just means they can choose to log in via Google or enter their email address and Patchworks password (simple sign-in).
We have already noted that OAuth2 is used to authorise access to Patchworks via Google sign-in. In this scenario, Patchworks requests an access token from Google; once a token is received, it is used to request the required user information for the sign-in process.
However, OAuth2 is also used for clients who wish to access Patchworks services via a Patchworks API endpoint. In this scenario, Patchworks provides an access token to clients, which is used to authenticate API requests.
For further information please see our API help pages.
Step 1 Log into the Patchworks dashboard.
Step 1 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
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.
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.
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.
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:
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).
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:
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:
Step 5 Click the disable MFA button:
Step 6 When prompted, confirm your decision:
Registration path | Sign-in mechanism | Sign-in process |
---|---|---|
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.
If you are an agency/partner with permissions to manage multiple companies, company profiles work a bit differently. Please refer to our section.
View associated with this company profile
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.
As the user who registers a company for a Patchworks account, you are granted 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 section.
Username and password
User accesses the Sign in to Patchworks page. Here, they select the register option and then provide an email address to be associated with their account, together with a password.
Google sign-in
User accesses the Sign in to Patchworks page. Here, they select the register option and enter an email address to be associated with Google Sign On. An email is sent to this address, containing a link to trigger the Google registration process.
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 'switched into' a company, you can do everything that a user directly associated with that company can do - for example, manage users, install connectors, build process flows, etc.).
This is preview documentation for a feature that is scheduled for an upcoming release.
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.
Only admin role users can add/manage message text.
Banner text persists until the message is removed from your company profile.
Step 1 Log into the Patchworks dashboard and access your company profile.
If you manage linked companies, 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.
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.
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.
The fact that a company is linked to your organisation 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 granted explicit permission for access.
Your Patchworks account must have the manager role in order to view linked companies for your organisation.
Step 1 Log into the Patchworks dashboard using your own Patchworks credentials and ensure that you are switched into your own company profile.
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, someone in your organisation with an administrator role can assign it to you.
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 switch into the associated company now. If no icon is shown it means that you have not been granted access to manage this company.
If you need to 'un-link' a managed company from your profile, please contact your Patchworks Partner Manager.
Once a company has been removed from your profile, it's no longer shown in your managed companies list - 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.
This section includes guidance for administrators to add and manage user accounts via your company profile. 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.
If you an an agency/partner who manages multiple companies via the Patchworks dashboard, please go to our Managing team members & users for linked companies section.
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 below summarise dashboard access by role. It's important to be aware that available features are determined by your core subscription tier. 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 entities associated with your own company profile. If you manage multiple company profiles, please see our Multi-company profiles section for more information.
When someone registers for a Patchworks account, they are assigned to the administrator
role, automatically. This user can go on to create additional users and/or assign roles to other users as needed.
Typically, there is one administrator for each organisation. If you require more than one user with this role, please raise a support request.
The tables below summarise access by role for key tasks within the Patchworks dashboard:
Company permissions refer to features that are available from settings > my company profile.
Company user permissions refer to features that are available from settings > my company profile > extra > users.
Permissions in this section are only relevant if you use Patchworks to manage multiple companies - i.e. you have a multi-company profile with one or more linked companies.
Marketplace permissions refer to features that are available from the marketplace page.
Private marketplace permissions refer to features that are available for users who manage linked companies via a multi-company profile.
Connector permissions refer to features that are available from the my connectors page.
Connector instance permissions refer to features that are available from the my connectors page.
Process flow permissions refer to features that are available from the process flows page.
Run logs permissions refer to features that are available from the run logs page.
General settings permissions refer to features that are available from the settings page.
For my company profile permissions see company permissions and company users.
Custom scripts permissions refer to features that are available from the scripts page.
Cross-reference lookup permissions refer to features that are available from the cross-reference lookups page.
Cache permissions refer to features that are available from the data caches page.
By default, new users are created with a user
role. Provided that you have an administrator
or manager
role, you can change this if required - the following rules apply:
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.
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 user
role:
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 6) they can access the Patchworks dashboard for their own company.
If you haven't upgraded to Core yet and are still using services to sync data, please check for roles & permissions information that's specific to services.
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
Task | Allowed roles |
---|---|
If you are a user with an , 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.
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.
Step 1 .
Roles determine the level of access that users have in the Patchworks dashboard. See the table for roles that you can set here.
View company profile
Update company profile name
Update company profile contact information
Add & manage banner messages
Delete company profile
View company users
Search company users
Create company user with an administrator
role
Create a company user with a manager
role
Create a company user with a user
or read-only
role
Update details for an existing company user (all roles)
Elevate an existing read-only
account to a user
role
Elevate an existing user
or read-only
account to a manager
role
Elevate an existing user
, read-only
or manager
account to an administrator
role
Reduce an existing manager
account to a user
or read-only
role
Reduce another administrator
account to a manager
, user
or read-only
role
Trigger password reset password for a company user
Update own user details
Elevate or reduce own role
Enable/disable own MFA
Delete company user
Delete own user profile
Adding & linking a new company to your multi-company profile
Switch in & out of linked companies
View linked companies for your multi-company profile
Un-linking a company from your multi-company profile
View team members for own company
Create new team member to manage a linked company
Assign user roles for an existing team member
View team members who manage a linked company
Grant & revoke access for team members to manage a linked company
Trigger a password reset for an existing team member
Removing a team member account
View 'native' users for a linked company
Create a new 'native' user for a linked company
Assign user roles for an existing 'native' company user
Trigger a password reset for an existing 'native' company user
Remove a 'native' linked company user from their company profile
Browse marketplace apps
Install marketplace apps
Build apps
Browse & view marketplace connectors
Install marketplace connectors
Update marketplace connectors
Browse & view marketplace process flows
Install marketplace process flows
Browse marketplace scripts
Preview script from scripts list
Install marketplace scripts
View own or parent private marketplace
Download resources (apps, connectors, process flows, scripts, cross-reference lookups)
Upload resources (apps, connectors, process flows, scripts, cross-reference lookups)
Browse installed connectors
View installed connector settings
Update installed connector settings
Delete installed connectors
View connector instances
View connector instance settings
Update connector instance settings
Delete connector instances
View process flow list
View canvas content for existing process flows
Create process flows (add/update/remove shapes)
Update process flows (add/update/remove shapes)
Create cache (cache shape settings)
Create data pool (de-dupe shape settings)
Delete process flows
Run process flow manually
Enable & deploy process flows (process flow settings)
Apply/remove labels (process flow settings)
Create labels (process flow settings)
Apply/remove email failure groups (process flow settings)
Add flow variables (process flow settings)
Update flow variables (process flow settings)
Remove flow variables (process flow settings)
Duplicate process flow (process flow settings)
View run logs list
View run log summary
View run log details
View run log payloads
Stop process flow
Manage own account settings
View notification groups
Add & manage notification groups
View audit logs
Search audit logs
View labels
Add & manage labels
View data pools
Add & manage data pools
View custom scripts list
View custom script details
Create custom scripts
Update custom scripts
Delete custom scripts
View installed cross-reference lookups
Search installed cross-reference lookups
View cross-reference lookup values
Add & manage cross-reference values
Delete cross-reference lookups
View existing cache lists
Search existing caches
View existing cache details
Update existing cache details
View existing cache contents
Clear existing cache contents
Delete caches
Obtain API token
Initialise process flow with payload
Administrator |
|
Manager |
|
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:
For more information please see our Roles & permissions summary page.
Step 1 Access the user list for your company profile.
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 Roles & permissions summary page.
Step 4 Save changes.
Existing users can access their company profile and view all associated user accounts. If you are a user with an administrator or manager role, you can also access options to create and manage user accounts.
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.
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.
If you are a user with an administrator or manager role, 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.
Step 1 Access the user list for your company profile.
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.
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.
Native company users. These users are directly associated with the linked company. They can log into their Patchworks dashboard with their own credentials.
The following criteria must be met for someone to access and manage linked company users. You must be:
To access your account settings, click your login name in the top, right-hand corner of the dashboard, then select the account settings option:
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.
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:
Step 1 Click your login name in the top, right-hand corner of the dashboard, then select the change password option:
When setting your password, 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 %)
Step 3 Click the submit button to save changes.
Your role | Allowed role changes |
---|---|
If you are a user with an , you can update general details for any existing user accounts associated with your company profile.
Step 1 .
As a multi-company profile user with , you will encounter two different types of user when you :
Team members with access. These users are directly associated with your company - they have (or can be given) .
A user AND
Your multi-company profile is . AND
Your user account has a . AND
You have been in question.
If you meet this criteria then you can and:
For information about managing company profiles for your linked companies, please see our section.
Having registered from a Patchworks account - or having been - a user account is created for you. If required, you can and:
Step 1 Access your page.
For more information please see our .
Step 2 Complete the change password form by entering your existing password, followed by the new required and confirmation of this:
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.
The company user can use the 'forgot password' option from the Patchworks login page to trigger their own password reset email:
Administrator
Can promote accounts to 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 manager
account to a user
account).
Manager
Can promote accounts to 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
account).
If you are a multi-company profile user with permission to manage another linked company, you can view and manage users associated with your own company profile.
Step 1 Log into the Patchworks dashboard using your own Patchworks credentials and ensure that you are switched into your own company profile.
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.
You can trigger a password reset email for another team member in your organisation, from your own company profile.
Step 1 Switch into the managed company that you want to update and view team members who manage that company.
Step 2 Click the name of the user that requires a password reset:
Step 3 Click the password reset option at the top of the page:
Step 4 This user will receive a Patchworks email containing instructions to reset their own password.
Your team member can use the 'forgot password' option from the Patchworks login page to trigger their own password reset email:
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.
Step 1 Switch into the managed company that you want to update and view team members who manage that company.
Step 2 The next step depends on the action that you wish to take:
Step 3 Save the company profile.
If you are a multi-company profile user with permission to manage another linked company, you can see who else in your team also manages that company.
Step 1 Log into the Patchworks dashboard using your own Patchworks credentials.
Step 2 Switch into the managed company that you want to review.
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 Granting & revoking permission for a team member to manage a company guide.
If your user account is associated with a manager or administrator role, you can remove other team member accounts from your company profile.
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 1 Access team members for your own company profile.
Step 2 Click the name of the user account that you want to remove:
Step 3 Click the 'delete' icon at the top of the page:
Step 4 When prompted, confirm this removal.
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 managed company users introduction.
Step 1 Log into the Patchworks dashboard using your own Patchworks credentials.
Step 2 Switch into the managed company that you want to review.
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.
If you are a multi-company profile user with permission to manage another linked company, you can add a new 'native' user for that company.
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 administrator
or manager
role, you can change this if required - the following rules apply:
For more information please see our Roles & permissions summary page.
Step 1 Access company users for the required linked company.
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 user
role:
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.
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
account).
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
account).
If you are a multi-company profile user with permission to manage another linked company, you can remove a 'native' user from their company profile.
When a company user is removed in this way, they can no longer log into the Patchworks dashboard.
Step 1 Access company users for the required linked company.
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:
...and then confirm this action:
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:
To access the Patchworks marketplace, simply log into the Patchworks dashboard and select marketplace from the left-hand navigation menu:
If your user account is associated with appropriate permissions, you can also access your own private marketplace.
A Patchworks app 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.
When you install an app from the Patchworks marketplace, 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 connectors page, process flows are added to your process flows list, custom scripts are added to your scripts list, etc.
For more information please see The anatomy of an app.
Having selected the apps option from the marketplace, you can browse and install apps:
Apps are displayed as tiles over a series of pages, which you can step through using page numbers at the bottom of the marketplace. Each app includes a visual summary of its component parts:
Here you can see which connectors are included in the app, the app title and creator, and a summary of contents. Summary icons are:
For a detailed view of what's included in an app, click anywhere on the tile:
This displays full details for the app so you can see what's included. From here, you can view all of the app's components and - if required - choose to install the app.
For more information, please see The anatomy of an app.
For all information about working with apps, please see our Apps section.
Icon | Shows |
---|---|
The number of connectors included in this app.
The number of process flows included in this app.
The number of cross-reference lookup tables included in this app.
The number of custom scripts included in this app.
If you would like to create a connector and submit it for review to be added to the public connector marketplace, we have outlined the following submission guide to ensure a high standard.
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 various pre-built connectors to accelerate the onboarding process. For in-depth guides on how to build a connector, please see our connector builder page:
For a demonstration video of our connector builder, watch our CEO Jim Herbert build a connector in under 5 minutes:
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.
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.
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.
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
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.
After a connector is approved and listed in the [Public Marketplace], you have certain responsibilities to maintain the connectors quality and compliance.
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.
Requirement | Summary |
---|---|
Item | Summary |
---|---|
Responsibility | 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
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.
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
If known, provide the expected completion date for development.
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.
If you manage multiple company profiles, it can be useful to share resources between them. With appropriate user roles & permissions, you can access a private marketplace for your company profile. Any apps, connectors, process flows, scripts, or cross-reference lookups that you build can be uploaded to your private marketplace, to be viewed/installed by:
Users associated with your own 'parent' company profile
Users associated with any 'child' companies that you manage
To upload resources to your private marketplace, your user account must be associated with an administrator role.
Any users associated with your own company profile, or with one of your 'child' company profiles can view everything in your private marketplace.
To download resources from your private marketplace, user accounts must be associated with a manager role or above.
You can bundle resources into an app and upload this app to your private marketplace. An app can include Patchworks connectors, custom connectors, process flows, scripts, cross-reference lookups, caches and data pools.
You can upload individual custom connectors, process flows, scripts, and cross-reference lookups to your private marketplace.
To upload a process flow (or bundle a process flow in an app), it must be enabled, and deployed.
To upload a script (or bundle a script in an app), it must be saved and deployed.
If you manage multiple company profiles and you have required permissions to upload resources to a private marketplace, you have two options for uploading resources:
Upload resources to the private marketplace associated with your own company profile. These resources can be installed by users associated with your own company profile, and by users in any 'child' companies that you manage.
Upload resources to the private marketplace associated with a child' company profile. These resources can only be installed for that 'child' company profile.
Whilst there may be occasions where it's useful to upload resources to the private marketplace for a 'child' company, our suggested approach is to:
Build/create resources in your 'parent' company profile.
Upload these resources to your own private marketplace so they can be shared by all of your 'child' company profiles.
It's important to think about which company profile you are switched into when building/creating resources that you want to upload to the private marketplace. Resources must exist in whichever company profile you are using to upload to the private marketplace.
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 installed a custom script it can be used in your process flows immediately, via the script shape.
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.
For all information about working with custom scripts, please see our Custom scripting section.
The process flows section of the marketplace allows you to browse and install a range of prebuilt process flows:
A prebuilt process flow includes all resources that are needed, including:
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:
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:
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.
For all information about working with process flows (including how to build your own), please see our Process flows section.
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.
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 install option.
For all information about working with cross-reference lookups, please see our Cross-reference lookups section.
Your private marketplace can be accessed via the main Patchworks marketplace - it's simply a case of toggling between 'public' and 'private'.
Step 3 Click the private tab to the right of the tabs:
Any resources that have been uploaded by users associated with your company profile or (for linked companies) your parent company profile are displayed - for example:
Resource | Notes |
---|---|
Resource | Notes |
---|---|
Step 1 Log into the dashboard and (if you're managing multiple company profiles) ensure that you're .
Step 2 Select a tab to view: , , , , or .
The connectors page allows you to browse, and all prebuilt connectors - these are 'standard' connectors that Patchworks builds and maintains.
When you install a connector, it is added to - from here you can (authenticated with your own credentials for that system) and then start working with these as .
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).
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:
For all information about working with connectors and instances, please see our section.
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 connector marketplace, a fresh copy of that connector is added alongside the existing one. You can then decide which one to use.
Custom scripts
All scripts defined in script shapes are installed and deployed, ready for use.
All cross-reference lookups defined as map shape field transformations are installed and ready for use.
Any data pools defined in de-dupe shapes are added. These are 'clean' data pools (i.e. with no associated data), ready for use.
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.
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.
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 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.
Indicates whether or not the process flow includes advanced shapes. Advanced shapes are: script, add to cache, load from cache. Read and write access to advanced shapes is determined by your Patchworks subscription.
Having added all resources that you want to include in an app (custom connectors, process flows, scripts, and cross-reference lookups) you can create an app and upload it to your private marketplace. This guide walks through the steps needed to achieve this.
Creating and uploading an app requires you to select existing resources that you want to include. As such, all required resources (custom connectors, process flows, scripts, and cross-reference lookups) must be created and ready to use within your own multi-company profile - i.e.:
Any custom connectors must be created
Any Patchworks prebuilt connectors must be installed
Any process flows must be created, enabled, and deployed
Any scripts must be saved and deployed
Any cross-reference lookups must be installed/created
If you manage multiple companies, it's important to ensure that you're switched to your own company profile before creating required apps (and associated resources). For more information please see our private marketplaces page.
Having created/installed/deployed all resources that you want to bundle as an app, follow the steps below to build and upload your app.
Step 1 Login to the Patchworks dashboard - make sure that you're switched to your own 'parent' company profile (rather than a 'child' company that you manage).
Step 2 Select the marketplace option from the left-hand navigation menu, then click the build new app option:
If you don't see this option, it's likely that your user account does not have the required permissions. Please contact Patchworks support if this is the case.
...now you can use the create an app form to select all resources that you want to include in this app:
Step 3 First, enter a name for this app (this name is displayed for users to see in your private marketplace) and - if available - a link for any existing help documentation.
Step 4 Use the process flows dropdown list to select any process flows that you want to include:
Here you'll see all process flows that have been created within the current company profile, which are deployed.
Step 5 By default, any connectors found in previously selected process flows (via connector shapes) will be selected for inclusion in this app. If required, you can use the select connectors field to choose additional connectors to be be included:
The select connectors list will show all connectors that you have installed or built, which are NOT already selected.
Step 6 By default, any cross-reference lookups found in previously selected process flows (via map shape transformations) will be selected for inclusion in this app. If required, you can use the select cross-reference lookups field to choose additional lookups to be be included:
The select cross-reference lookups list will show all lookups that you have installed or created, which are NOT already selected.
Step 7 By default, any caches found in previously selected process flows (via add to cache and load from cache shapes) will be selected for inclusion in this app. If required, you can use the select caches field to choose additional caches to be be included:
The select caches list will show all caches that you have created, which are NOT already selected.
Step 8 By default, any data pools found in previously selected process flows (via the de-dupe shape) will be selected for inclusion in this app. If required, you can use the select data pools field to choose additional data pools to be be included:
Step 9 Click the upload button to upload this app to your private marketplace:
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:
When you install apps 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 notification centre icon - from here you can view messages, navigate to associated resources (where applicable), or clear notifications.
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:
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.
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 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.
Step 1 Login to the Patchworks dashboard - make sure that you're switched to your own 'parent' company profile (rather than a 'child' company that you manage).
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.
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:
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 an app, you don't need to upload it separately - please see or .
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.
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 an app, you don't need to upload it separately - please see Uploading apps to your private marketplace.
When you upload a process flow, any configured connectors, scripts, cross-reference lookups, caches and de-dupe pools will be included.
Ensure that the process flow you want to upload is enabled and deployed.
Step 1 Login to the Patchworks dashboard - make sure that you're switched to your own 'parent' company profile (rather than a 'child' company that you manage).
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 canvas 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 contact Patchworks support 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 notification centre for confirmation if you miss the popup message when this is done:
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 Uploading process flows to your private marketplace or Uploading apps to your private marketplace.
Ensure that the script that you want to upload is saved and deployed.
Step 1 Login to the Patchworks dashboard - make sure that you're switched to your own 'parent' company profile (rather than a 'child' company that you manage).
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 contact Patchworks support 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:
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.
Step 1 Login to the Patchworks dashboard - make sure that you're switched to your own 'parent' company profile (rather than a 'child' company that you manage).
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:
Step 4 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:
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 .
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.
If you need to change any component within an app that's in your private marketplace (i.e. an app that has been uploaded to your private marketplace and is available from the apps tab), you need to follow the steps below.
Step 1 Make the required changes to connectors, process flows, scripts, or cross-reference lookups.
Step 2 Delete the existing app from your private marketplace.
Step 3 Upload a new app with updated resources.
Uploading a new app does not update any existing installations. If a private marketplace app has been installed (either in your own company profile or for a linked company profile) you will need to switch to the relevant company profile and make any required changes to installed resources.
If you need to change a custom connector that's in your private marketplace (i.e. a connector that has been uploaded to your private marketplace and is available from the connectors tab), you can make required changes and then re-upload the connector - the steps for this are:
Step 1 Select process flows | connectors & instances from the left-hand navigation menu to view all of your installed/custom-built connectors.
Step 2 Find the connector that you want to update and make changes to the connector settings as needed:
Step 3 When any changes are saved for a connector that has already been uploaded to the marketplace, a re-upload button becomes available:
Step 4 If this connector is in use for any of your linked ('child') companies, you'll see an update available option when viewing connectors in that company profile - for example:
...use this to install your updates.
If you need to change a process flow, script, or cross-reference lookup that's in your private marketplace, you need to follow the steps below.
Step 1 Make the required changes to the resource.
If you change a process flow, ensure that the required version is enabled and deployed.
If you change a script, ensure that it's saved and deployed
Step 2 Delete the existing resource from your private marketplace.
Step 3 Upload the updated resource.
Uploading a new resource does not update any existing installations. If a private marketplace resource has been installed (either in your own company profile or for a linked company profile) you will need to switch to the relevant company profile and make any required changes there.
Installing a Patchworks app is a straightforward, one-click operation via the Patchworks marketplace.
Once installed, all app components (connectors, process flows, scripts, etc.) are added to the relevant area of your Patchworks dashboard - connectors are added to your connectors page, process flows are added to your process flows list, custom scripts are added to your scripts list, etc.
You then need to complete a few setup tasks in order to make associated process flows live. This page details the installation and post-installation setup steps required.
If you install an app which includes a connector that you've already installed from the connector marketplace, a fresh copy of that connector is installed alongside the existing one. You can then decide which one to use.
Prior to installing an app, you have the option to add instances for any connectors that are included - this is where you provide your authentication credentials for the associated third-party system. If you have the required credentials to hand then you can save some time by adding the instances here, but it's not mandatory - it's fine to simply install the app and add instances afterwards via your manage connectors page.
When an app is installed, its process flows are disabled and set to a draft status. When you are ready, you should enable and deploy any process flows that you want to use. Keep in mind that your Patchworks subscription tier determines the number of process flows and connectors that you can deploy.
To install an app, follow the steps below.
Step 1 Select marketplace from the left-hand navigation menu, then access the apps section.
Step 2 Click anywhere on the app that you want to install:
Step 3 Review the contents of the app. If required, you can choose to exclude individual process flows by toggling the associated install button OFF:
Typically, process flows are key to the successful implementation of apps. We recommend installing and using the process flows that are included unless you have a specific reason not to do so.
Step 4 If you have credentials to hand for required connector instances, move down to the connectors section and click the add instance option:
You're then prompted to enter details for the instance, including authentication credentials. For more information please see Adding connector instances prior to installation.
You cannot add instances that require OAuth 2 (Client Credentials) authentication, via the app install process. If an app includes connectors that require OAuth 2 (Client Credentials) authentication then you should install the app and add instances afterwards via your manage connectors page.
Step 5 Click the install button at the top of the app details page.
Step 6 You are returned to the marketplace and a confirmation message is displayed, advising that the app is queued for installation:
Step 7 Typically, installation is completed in a matter of seconds, but you can navigate away in the meantime. Once the installation is complete, you'll see a notification in the top information bar - for example:
Having installed an app, follow the steps below to complete its setup:
This step isn't mandatory, but it may be useful to have details of what components have been installed for this app. To do this, select the app from the marketplace once again, so you can see a list of all components.
Select process flows | connectors & instances from the left-hand navigation menu. Here you'll find all of your installed connectors.
Any connectors installed via the app will be shown here. If the app installs a connector that you already had, you'll find a fresh version of the connector next to your existing one, so you can decide which one to use.
Once you're satisfied that all required instances are in place with your connector credentials, you need to apply these to connection shapes in any process flows associated with the app.
To do this, select process flows | process flows from the left-hand navigation menu. Here you'll find all of your process flows, including any that were added via the app installation.
Edit the first process flow associated with the app and check all connection shapes - you'll notice a warning symbol, indicating that the shape is not configured - for example:
Click the settings icon for the connection shape and choose the required instance and endpoint (leave all other connection settings as the default):
Don't forget to save your changes!
Check all other shapes in the process flow for a warning symbol. If there is a warning, open settings and click save to confirm.
Other shapes should not need to be changed but sometimes you may need to confirm default details by saving the shape settings.
Once you're satisfied that all connection shapes are configured and you're ready to put the process flow live, you should deploy it. To do this, access process flow settings and change the draft
status to deployed
:
For more information please see Process flow versioning.
Your Patchworks subscription determines the number of deployed connectors and process flows that are permitted.
The final step is to enable the process flow. To do this, access process flow settings and toggle the ENABLE option to ON:
This section contains quick, task-based guidance for queries that may arise when working with the Patchworks marketplace.
An app can include any number/combination of the following components:
As you browse the apps marketplace, you'll see that each app is displayed with a visual summary of what's included - for example:
For more information about this summary please see The Patchworks marketplace.
If you click on an app tile, you can see a detailed breakdown of what's included:
From here you can:
Any connectors included with the app will be installed as part of the app install process. To use these connectors in process flows, you must add an instance of each - this is where you provide your authentication credentials for the associated third-party system.
If you have your credentials to hand, you can provide them on the view app page, prior to installation - for example:
Each connector that's included in the app is displayed with an add instance option. If you select this option, you are prompted to choose an authentication method and then enter your credentials - for example:
If you save instance details and then go on to install the app, these instances are created as part of the installation and will be available for use in process flows immediately.
It's not mandatory to add your instances as part of the app installation. If preferred, you can simply install the app and add instances afterwards via your manage connectors page.
You cannot add instances that require OAuth 2 (Client Credentials) authentication, via the app install process. If an app includes connectors that require OAuth 2 (Client Credentials) authentication then you should install the app and add instances afterwards via your manage connectors page.
If an app which 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 apps. We recommend installing and using the process flows that are included unless you have a specific reason not to do so.
When an app or a process flow is installed, it usually includes dependencies such as connectors, scripts, caches, etc. If a dependency fails to install or has not been deployed correctly, this can cause associated process flows to fail or give unexpected results.
Check the following:
Once an app or process flow has been installed from the marketplace, a series of confirmation messages is displayed - one message for each component - for example:
Typically these are 'success' messages, but occasionally you may see a failure for one or more components. These messages are displayed briefly and then cleared however, you can review them later from your notifications centre - click the notifications icon in the top information bar:
Notifications remain in your notifications centre until you choose to mark them as read:
When installing an app you have the option to exclude given process flows. If you've already been working on process flows that you installed originally and don't want to lose these changes, you should exclude them before running the install again.
Installation instructions for Patchworks apps and process flows include some post-install setup steps - these must be completed before any associated process flows will run correctly. Double-check these steps to ensure that all required setup has been completed:
Any custom scripts associated with a Patchworks app or process flow are installed and deployed as part of the installation process. However, if an installed process flow is not working as expected, it's a good idea to check that all required scripts are deployed. To do this, follow the steps below.
Step 1 Select scripts from the left-hand navigation menu:
Step 2 Check the deployment status column for listed scripts - you're looking for any that show as un-deployed:
Step 3 Click the name of the first un-deployed script:
Step 4 Scroll down and click the save and deploy button:
Step 5 Repeat these steps for any other scripts that need to be deployed.
Resource | Notes |
---|---|
You've installed a process flow from the Patchworks marketplace via an or the section. When you run the process flow it either fails or does not work as expected.
If any part of the installation is shown to have failed, you can install the or again.
An app will always include at least one process flow.
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 app 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.
Custom scripts
All scripts defined in process flow script shapes are installed and deployed, ready for use.
All cross-reference lookups defined as process flow map shape field transformations are installed and ready for use.
Any data pools defined in process flow de-dupe shapes are added. These are 'clean' data pools (i.e. with no associated data), ready for 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.
A Patchworks app 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.
You can browse and install available apps from the apps section of the Patchworks marketplace:
If your user account is associated with an administrator role, you can build your own apps and upload them to your private marketplace.
If you would like to make your app available in the Patchworks public marketplace, you can submit it for approval.
The Lightspeed X-Series & Shopify app includes everything you need to sync:
Stock data from Shopify to Lightspeed X-Series
Product data from Shopify to Lightspeed X-Series
Sales order data from Lightspeed X-Series to Shopify
Customer data from Lightspeed X-Series to Shopify
Process flows are built to implement powerful data flows between connector instances in an intuitive, visual way - this is where we define if, when, what, and how data is synced. All process flows installed with this app are shown below.
You'll find installed process flows in the manage process flows area of your dashboard. For product documentation please see Process flows.
A connector is a generic integration of a third-party business system/application. Connector instances (configured by you as part of the app install process, or later via your connectors page), are added to process flows via the connector shape. All connectors installed with this app are shown below.
You'll find installed connectors in the manage connectors area of your dashboard. For product documentation please see Connectors & instances.
Custom scripts are implemented via the script shape, and are typically used when source data needs to be manipulated beyond the capabilities that standard transform functions provide. All scripts installed with this app are shown below.
You'll find installed scripts in the scripts area of your dashboard. For product documentation please see Custom scripting.
Cross-reference lookups are used for cases where sets of static values are commonly known by another value. If source data which includes values that always need to be changed to an alternative term, a cross-reference lookup can be used to transform required data fields (via the map shape). All cross-reference lookups installed with this app are shown below.
You'll find installed cross-reference lookups in the cross-reference lookups area of your dashboard. For product documentation please see Cross-reference lookups.
Caches are specified in the add to cache shape, and used to store data (temporarily) at given points in a process flow. Typically, this is done so the data at that point in time can be referenced later in the same process flow, or by other process flows, via a load from cache shape. Allcaches installed with this app are shown below.
You'll find installed caches in the data caches area of your dashboard. For product documentation please see Cache shapes.
Data pools are used by the de-dupe shape in process flows. They store unique key field values that have passed through the shape, so subsequent records can be checked and matched for duplication. All data pools installed with this app are shown below.
Script title | Summary |
---|---|
Cross-reference lookup name | Cross-reference lookup description |
---|---|
Cache name | Cache type |
---|---|
Data pool name | Unique key | Applicable process flows |
---|---|---|
Check if customer exists in Shopify
Checks if customers already exist in Shopify.
Convert Order ID to Metadata
Converts order id
to metadata.
Set Inventory ID
Sets inventory ID
to metadata.
Set Product ID
Sets product ID
to metadata.
Set Shopify Customer ID
Sets customer ID
to metadata.
-
-
Sales Cache
Flow run
Stock Cache
Flow run
Lightspeed Customers
customer email
The SEKO Logistics & Shopify app includes everything you need to sync:
Inventory data from SEKO to Shopify
Fulfillments from SEKO to Shopify
Sales orders from Shopify to SEKO web sales orders
Process flows are built to implement powerful data flows between connector instances in an intuitive, visual way - this is where we define if, when, what, and how data is synced. All process flows installed with this app are shown below.
You'll find installed process flows in the manage process flows area of your dashboard. For product documentation please see Process flows.
A connector is a generic integration of a third-party business system/application. Connector instances (configured by you as part of the app install process, or later via your connectors page), are added to process flows via the connector shape. All connectors installed with this app are shown below.
You'll find installed connectors in the manage connectors area of your dashboard. For product documentation please see Connectors & instances.
Custom scripts are implemented via the script shape, and are typically used when source data needs to be manipulated beyond the capabilities that standard transform functions provide. All scripts installed with this app are shown below.
You'll find installed scripts in the scripts area of your dashboard. For product documentation please see Custom scripting.
Cross-reference lookups are used for cases where sets of static values are commonly known by another value. If source data which includes values that always need to be changed to an alternative term, a cross-reference lookup can be used to transform required data fields (via the map shape). All cross-reference lookups installed with this app are shown below.
You'll find installed cross-reference lookups in the cross-reference lookups area of your dashboard. For product documentation please see Cross-reference lookups.
Caches are specified in the add to cache shape, and used to store data (temporarily) at given points in a process flow. Typically, this is done so the data at that point in time can be referenced later in the same process flow, or by other process flows, via a load from cache shape. Allcaches installed with this app are shown below.
You'll find installed caches in the data caches area of your dashboard. For product documentation please see Cache shapes.
Data pools are used by the de-dupe shape in process flows. They store unique key field values that have passed through the shape, so subsequent records can be checked and matched for duplication. All data pools installed with this app are shown below.
The Shopify & NetSuite app includes everything you need to sync customer details and orders from Shopify to NetSuite.
Process flows are built to implement powerful data flows between connector instances in an intuitive, visual way - this is where we define if, when, what, and how data is synced. All process flows installed with this app are shown below.
You'll find installed process flows in the manage process flows area of your dashboard. For product documentation please see Process flows.
A connector is a generic integration of a third-party business system/application. Connector instances (configured by you as part of the app install process, or later via your connectors page), are added to process flows via the connector shape. All connectors installed with this app are shown below.
You'll find installed connectors in the manage connectors area of your dashboard. For product documentation please see Connectors & instances.
Custom scripts are implemented via the script shape, and are typically used when source data needs to be manipulated beyond the capabilities that standard transform functions provide. All scripts installed with this app are shown below.
You'll find installed scripts in the scripts area of your dashboard. For product documentation please see Custom scripting.
Cross-reference lookups are used for cases where sets of static values are commonly known by another value. If source data which includes values that always need to be changed to an alternative term, a cross-reference lookup can be used to transform required data fields (via the map shape). All cross-reference lookups installed with this app are shown below.
You'll find installed cross-reference lookups in the cross-reference lookups area of your dashboard. For product documentation please see Cross-reference lookups.
Caches are specified in the add to cache shape, and used to store data (temporarily) at given points in a process flow. Typically, this is done so the data at that point in time can be referenced later in the same process flow, or by other process flows, via a load from cache shape. Allcaches installed with this app are shown below.
You'll find installed caches in the data caches area of your dashboard. For product documentation please see Cache shapes.
Data pools are used by the de-dupe shape in process flows. They store unique key field values that have passed through the shape, so subsequent records can be checked and matched for duplication. All data pools installed with this app are shown below.
Understanding the relationship between connectors and instances is key when you are working with process flows. In short:
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.
An instance of a connector is unique to your company, personalised with your own credentials and settings. Any instances that you add are available for use in process flows when you add a connection shape.
These relationships are illustrated below:
The chances are that your business uses a range of third-party applications - for example, you might take sales orders in Shopify, manage customer data in Voyado, and handle financial accounts in NetSuite.
In Patchworks, a connector is an integration of a third-party business system/application that you can install if you need to sync data from/to the associated application. A curated library of prebuilt connectors can be found in the Patchworks marketplace.
If you need to integrate a third-party application that doesn't have a prebuilt connector in the Patchworks marketplace - and if you have technical knowledge of APIs and working with data structures - you can use the connector builder to integrate any application with a REST API.
When you install a connector, you are installing a package of generic configuration and setup that's required to integrate the associated third-party application in Patchworks. You only need to install a given connector once. After that, you can add as many instances of it as you need for use in your process flows.
Similarly, if you update an installed connector, that update is applied to all associated instances automatically.
The Patchworks development team maintains all prebuilt connectors in the marketplace. If you have installed a connector, you may find that updates become available in the marketplace - you can decide if/when you apply these updates.
An instance is the mechanism used to configure a connector for your own use in process flows.
Instances are added to process flows via the connection shape.
Every instance requires authentication credentials that allow you to access the associated third-party application. Typically, you'll create one instance for each set of credentials that you have for a given connector that you want to use in process flows. The examples below show how this might work in practice.
Event connectors are a different sort of connector, used to configure listeners for message brokers such as RabbitMQ. For more information please see the Event connectors section.
Adobe Commerce (formerly Magento) is a flexible, scalable commerce platform that lets you create uniquely personalised B2B and B2C experiences.
API documentation for Adobe Commerce (used to build this connector) can be found via the link below:
When adding connector instances for Adobe Commerce, the following authentication methods are supported:
To obtain the token (actually an access token) required for Patchworks to access your Magento 2 data, you must create an integration. To do this, follow the steps below.
Step 1 Log into your Magento admin console.
Step2 Click on the system button with a cog icon to open the menu:
Step 3 Click on integrations under the extensions header. This will load the following page:
Step 4 Click on add new integration to start adding a new integration.
Step 5 Provide the required information in the first form. We suggest setting the name as 'Patchworks':
Step 6 Click API under basic settings and assign the required permissions:
Step 7 Click save. You will then be taken to the below page:
Step 8 Click activate for the integration you just saved and when prompted, confirm that the permissions are correct:
Step 9 Click allow to display integration tokens - add them all to your password manager, ready for use in your Patchworks setup:
The access token is required for Patchworks, but it's worth logging all token information returned here.
To find the URL required to add a Patchworks connector, log into your Magento 2 admin console and check the URL in your browser's address bar. You need everything up to and including 'magento.com' - for example:
If you are using Magento 2.4.4 or later, the allow OAuth access tokens to be used as standalone bearer tokens option must be set to yes. To do this, follow the steps below.
Step 1 Log into your Magento admin console.
Step2 Select stores from the navigation menu:.
Step 4 Expand the services navigation option and select OAuth:
Step 5 Set the Allow OAuth Access Tokens to be used as standalone Bearer tokens option to yes:
Script title | Summary |
---|---|
Cross-reference lookup name | Cross-reference lookup description |
---|---|
Cache name | Cache type |
---|---|
Data pool name | Unique key | Applicable process flows |
---|---|---|
Script title | Summary |
---|---|
Cross-reference lookup name | Cross-reference lookup description |
---|---|
Cache name | Cache type |
---|---|
Data pool name | Unique key | Applicable process flows |
---|---|---|
When a user chooses to using token authentication, the credentials below are prompted:
Credential | Required? | Notes |
---|
When a user chooses to using token authentication, the credentials below are prompted:
Credential | Required? | Notes |
---|
Step 3 Select the configuration option:
Add lineNumber to SalesOrderLineItem and Remove zero qty lines
Add lineNumber
to SalesOrderLineItem
and remove zero quantity lines.
SKU Search Script
Extracts and formats product codes.
GQL Set Onhand Inv Level
Set the Onhand
inventory level input to Shopify GQL.
Add SetQuantities to Stock Update GQL
Add SetQuantities
to stock update GQL
-
-
AvailableStock
Flow run
FulfillmentOrder
Flow run
FulfillmentOrderMulti
Flow run
-
-
-
-
-
-
-
Orders
Flow run
-
-
-
| Enter your Aero Commerce host (obtained via your Aero Commerce application). |
| Enter the token provided for your Aero Commerce account (obtained via your Aero Commerce application). |
| Displayed immediately after creating a new integration in the Magento admin console. |
| Displayed immediately after creating a new integration in the Magento admin console. |
Algolia is a search-as-a-service API that focuses on providing the best experience for end users.
When adding connector instances for Algolia, the following authentication methods are supported:
When a user chooses to add a connector instance using API key authentication, the credentials below are prompted:
API and authentication information for the Patchworks prebuilt Akeneo connector.
Akeneo is a product information management and product data intelligence solution.
API documentation for Akeneo (used to build this connector) can be found via the link below:
When adding connector instances for Akeneo, the following authentication methods are supported:
The required credentials for adding a Patchworks instance of the Akeneo prebuilt connector can be obtained by adding an Akeneo connection for Patchworks, in your Akeneo dashboard. The steps required to add a new connection are summarised below:
Step 1 Log into your Akeneo dashboard.
Step 2 Select connect from the left-hand navigation bar:
Step 3 Select connection settings from the connect menu to access existing Akeneo connections:
Step 4 Click the create button:
Step 5 A new set of credentials is created for this connection and displayed in a credentials panel:
Credential | Required? | Notes |
---|---|---|
When a user chooses to using Akeneo Auth authentication, the credentials below are prompted:
Credential | Required? | Notes |
---|
application id
api key
index name
| The client id generated for your Patchworks connection in Akeneo. |
| The client secret generated for your Patchworks connection in Akeneo. |
| The URL used to access your Akeneo store without the |
| The username generated for your Patchworks connection in Akeneo. |
| The password generated for your Patchworks connection in Akeneo. |
| Set to |
| Set to |
would be entered as:
Airtable is a single platform which empowers teams to build custom apps on top of shared data.
Airtable's API documentation (used to build this connector) can be found via the link below:
When adding connector instances for Airtable, the following authentication methods are supported:
When a user chooses to add a connector instance using token authentication, the credentials below are prompted:
When a user chooses to add a connector instance using token authentication, the credentials below are prompted:
Obtaining a token
Personal access tokens are created from Airtable. Please refer to the Airtable documentation: Personal Access Tokens basic actions.
Obtaining the base id and table id
Base and table ids are available from the Airtable API page associated with your Airtable base. Open the Airtable Standard API page and click the Airtable base that you want to use - from here you'll see API information associated with the base, which includes base
and table
ids.
Credential | Required? | Notes |
---|---|---|
token
base id
The id associated with the base you want to use for this connection.
table id
The id associated with whichever table within the base that you want to use for this connection.
Avasam is a dropshipping platform for retailers and sellers in the UK.
API documentation for Avasam (used to build this connector) can be found via the link below:
When adding connector instances for Avasam, the following authentication methods are supported:
When a user chooses to using OAuth 2 (client credentials) authentication, the credentials below are prompted:
Credential | Required? | Notes |
---|
| Leave set to |
|
|
| Leave set to |
BigCommerce is a cloud-based eCommerce platform, providing software as a service services to retailers.
API documentation for BigCommerce (used to build this connector) can be found via the link below:
When adding connector instances for BigCommerce, the following authentication methods are supported:
When a user chooses to add a connector instance using token authentication, the credentials below are prompted:
Finding your store hash and access token
Step 1 Follow the instructions provided by BigCommerce - here:
Step 2 Having completed these steps, you will see an API path - the number at the end is the store hash. Next, a pop-up window displays the client ID, client secret and access token. Add these details to your password manager immediately as they are only shown once.
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.
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.
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.
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.
Our development process utilises TypeScript for type safety, PHPUnit for comprehensive testing, NPM for efficient package management, and Docker for containerisation.
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 secret key generated to allow API access for Patchworks, via the Avasam dashboard (user management). Please see for guidance on generating API credentials.
The consumer key generated to allow API access for Patchworks, via the Avasam dashboard (user management). Please see for guidance on generating API credentials.
Credential | Required? | Notes |
---|---|---|
store hash
Generated when you follow instructions to create a BigCommerce API account for your store.
token
Generated when you follow instructions to create a BigCommerce API account for your store.
Type | IPs |
---|---|
Patchworks NordLayer VPN
89.47.62.54
AWS Production K8s Cluster
18.168.241.46
18.168.94.149
13.41.170.82
Adding & linking a new managed company for Patchworks partners and agencies.
Step 1 Click the arrow associated with your current company name and select the switch companies option:
The managed companies page is shown, listing all companies that are linked to your organisation (i.e. all companies that can be managed by your team):
If your organisation manages a lot of companies this list might be long, running over multiple pages. If necessary, use the search field to quickly 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.
If required, you can copy process flows from one of your managed companies into another. For further information please see
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:
Step 2 The managed companies page is shown.
Typically, no managed companies will be shown because you're currently switched into a managed company rather than your own profile.
Step 3 Click the switch to original company button:
Step 4 You are switched back to your own profile and the managed companies page updates to show all companies that your team can manage:
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.
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.
Single sign-on via Google is supported.
Bob is assigned the manager
role
By default, the manager
role has required permissions to create and update custom scripts
Bob's company is associated with a standard
subscription tier, 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 marketplace apps), but he cannot make any changes and he cannot create his own scripts
Jack is assigned the manager
role
By default, the manager
role has required permissions to create and update custom scripts
Jack's company is associated with a professional
subscription tier, which permits full access to custom scripts and other advanced features
Jack can view, create and update custom scripts as needed
If you have a new company that you need to link to your multi-company profile, please contact your Patchworks Partner Manager. If you don't have a Partner Manager, please .
Once a company has been linked to your profile you can , who can then and complete required tasks.
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 .
You can only switch into companies that you have been .
Your Patchworks account must have the in order to view linked companies for your organisation.
If you don’t see this option it means that you don’t have not been .
If you have been , you'll see an icon in the switch column:
If no icon is shown it means that you have not been .
Step 4 You can now proceed to complete any required setup for this company (for example, , add , , etc.).
Step 5 When you've finished working with this company, you should to ensure that you don't make any subsequent updates in error.
If you don’t see this option it means that you don’t have not been .
Kubernetes pod and node auto-scaling Ensure that integrations run consistently, even in the busiest times. See our page for more information.
(formerly Vend) is a retail POS, inventory management, and eCommerce solution.
is a cloud-based, fully hosted commerce platform which can be used to create and manage online stores.
Sync inventory and fulfillments from SEKO to Shopify and/or sync sales orders from Shopify to SEKO.
Sync customer details and orders from Shopify to NetSuite.
Sync products/orders from Shopify to Peoplevox and/or sync stock, refunds, and fulfilments from Peoplevox to Shopify. Also includes flows for Peoplevox event subscription.
Sync orders from TikTok to Veeqo.
is a cloud-based, fully hosted commerce platform which can be used to create and manage online stores.
provides complete supply chain solutions, specialising in transportation, logistics, forwarding and warehousing.
is a cloud-based solution that helps businesses manage all aspects of their operations.
is a cloud-based, fully hosted commerce platform which can be used to create and manage online stores.
If your Patchworks user account is associated with a multi-company profile and you have been granted permission to manage a linked company, 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):
If you are a multi-company profile user with permission to manage another linked company, 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:
For more information about 'native' company users and agency/partner team members please see our managed company users introduction.
If you are a multi-company profile user with permission to manage another linked company, you can add new team members to your own company profile. Once a user is added you can (if required) go on to grant them permission to manage other companies.
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 administrator role.
Step 1 Access team members for your own company profile.
You must be logged in with an administrator account to complete these steps.
Step 2 Click the create user button:
Step 3 Enter the person's name and email address:
The email address provided here is used to log into the Patchworks dashboard.
Step 4 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 5 The user roles tab is displayed and you'll see that the new account is created - by default, new accounts are created with a user role:
Permission to manage other companies can only be granted for team members with a manager role, so you need to assign this role now.
Step 6 Click the assign role button against the manager role:
If your user account isn't associated with an administrator role, you won't be able to make this change.
Step 7 Click the remove role button for the user role:
Step 8 When prompted, confirm this change.
Step 9 Save changes.
Step 10 If required, you can now go on to grant this user access to manage any companies that you currently manage.
When a new team member is added, 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 administrator
or manager
role, you can change the role associated with other lesser-role team members. The following rules apply:
For more information please see our Roles & permissions summary page.
Step 1 Access team members for your own company profile.
Step 2 Click the name of the user account that you want to update:
Step 3 The user roles tab is displayed and you'll see which roles are currently assigned for this account:
Step 4 Assign (and/or remove) roles as needed by clicking the appropriate assign role / remove role button.
Step 5 Save changes.
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 add a new company user account, 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 administrator
or manager
role, you can change the role associated with other lesser-role company users. The following rules apply:
For more information please see our Roles & permissions summary page.
Step 1 Access company users for the required linked company.
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.
If you are a multi-company profile user with permission to manage another linked company, 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.
Step 1 Access company users for the required linked company.
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 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.
This document outlines the approval process for developers submitting public apps for inclusion in the [Public Marketplace]. The [Public Marketplace] is a platform where users can discover, install, and use various pre-built apps to accelerate the onboarding process.
If you are a developer seeking to submit a public app for inclusion in the [Public Marketplace], you must ensure that their app meets the following requirements.
The submission process for public apps consists of the following steps:
Before the development of the app commences, you are encouraged to submit in writing (to your partner manager) the following details on any app(s) you intend to create.
Before submitting an app for approval, you are encouraged to conduct a thorough review of your app to ensure it meets all requirements outlined above.
This includes testing the app for functionality, performance, and security.
Once the app 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
Once the app 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:
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.
Review any scripts or custom components used in the app.
After an app is approved and listed in the [Public Marketplace], you have certain responsibilities to maintain the app's quality and compliance.
The approval process outlined above is designed to ensure that public apps 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 app submission process, please refer to the [Public Marketplace] developer documentation or contact the [Public Marketplace] support team.
The Veeqo & TikTok app includes everything you need to sync orders from TikTok to Veeqo.
Process flows are built to implement powerful data flows between connector instances in an intuitive, visual way - this is where we define if, when, what, and how data is synced. All process flows installed with this app are shown below.
The Shopify & Descartes Peoplevox app includes everything you need to:
Sync products from Shopify to Peoplevox
Sync orders from Shopify to Peoplevox
Sync stock from Peoplevox events to Shopify
Sync refunds (using returns report data) from Peoplevox to Shopify
Sync fulfilments from Peoplevox events to Shopify
Subscribe to Peoplevox fulfilment post events
Subscribe to Peoplevox stock events (using site filters)
Unsubscribe from Peoplevox events
Process flows are built to implement powerful data flows between connector instances in an intuitive, visual way - this is where we define if, when, what, and how data is synced. All process flows installed with this app are shown below.
Your role | Allowed role changes |
---|---|
Your role | Allowed role changes |
---|---|
Requirement | Summary |
---|
Item | Summary |
---|
Responsibility | Summary |
---|
You'll find installed process flows in the . For product documentation please see .
A is a generic integration of a third-party business system/application. Connector instances (configured by you as part of the , or later via your ), are added to process flows via the . All connectors installed with this app are shown below.
You'll find installed connectors in the . For product documentation please see .
Custom scripts are implemented via the , and are typically used when source data needs to be manipulated beyond the capabilities that standard provide. All scripts installed with this app are shown below.
Script title | Summary |
---|
You'll find installed scripts in the . For product documentation please see .
Cross-reference lookups are used for cases where sets of static values are commonly known by another value. If source data which includes values that always need to be changed to an alternative term, a can be used to required data fields (via the shape). All cross-reference lookups installed with this app are shown below.
Cross-reference lookup name | Cross-reference lookup description |
---|
You'll find installed cross-reference lookups in the . For product documentation please see .
Caches are specified in the , and used to store data (temporarily) at given points in a process flow. Typically, this is done so the data at that point in time can be referenced later in the same process flow, or by other process flows, via a . Allcaches installed with this app are shown below.
Cache name | Cache type |
---|
You'll find installed caches in the . For product documentation please see .
Data pools are used by the in process flows. They store unique key field values that have passed through the shape, so subsequent records can be checked and matched for duplication. All data pools installed with this app are shown below.
Data pool name | Unique key | Applicable process flows |
---|
You'll find installed process flows in the . For product documentation please see .
A is a generic integration of a third-party business system/application. Connector instances (configured by you as part of the , or later via your ), are added to process flows via the . All connectors installed with this app are shown below.
You'll find installed connectors in the . For product documentation please see .
Custom scripts are implemented via the , and are typically used when source data needs to be manipulated beyond the capabilities that standard provide. All scripts installed with this app are shown below.
Script | Summary |
---|
You'll find installed scripts in the . For product documentation please see .
Cross-reference lookups are used for cases where sets of static values are commonly known by another value. If source data which includes values that always need to be changed to an alternative term, a can be used to required data fields (via the shape). All cross-reference lookups installed with this app are shown below.
Cross-reference lookup name | Cross-reference lookup description |
---|
You'll find installed cross-reference lookups in the . For product documentation please see .
Caches are specified in the , and used to store data (temporarily) at given points in a process flow. Typically, this is done so the data at that point in time can be referenced later in the same process flow, or by other process flows, via a . Allcaches installed with this app are shown below.
Cache name | Cache type |
---|
You'll find installed caches in the . For product documentation please see .
Data pools are used by the in process flows. They store unique key field values that have passed through the shape, so subsequent records can be checked and matched for duplication. All data pools installed with this app are shown below.
Data pool name | Unique key | Applicable process flows |
---|
The company user can use the 'forgot password' option from the Patchworks login page to trigger their own password reset email:
Administrator
Can promote accounts to 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 manager
account to a user
account).
Manager
Can promote accounts to 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
account).
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
account).
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
account).
Compliance | The app must comply with all relevant laws, regulations, and policies, including those related to data privacy, security, and intellectual property rights. |
Functionality | The app 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 app must meet quality standards for performance, reliability, and user experience. It should not degrade the performance or stability of the [Public Marketplace] platform. |
Security | The app 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 app should be compatible with the [Public Marketplace] platform and any relevant operating systems or devices. It should not rely on unsupported features or dependencies. |
Connector compatibility | The app should use existing connectors found on the [Connector Marketplace]. Any modifications to existing connectors in order to support the app must be submitted separately prior to the app review process. |
Documentation | Developers should provide clear and comprehensive documentation for their app, 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 app. We will host this documentation on our public documentation platform. |
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 app(s). |
App name | The name of the app to be displayed in the [Public Marketplace]. |
Expected completion date | If known, provide the expected completion date for development. |
Connectors | Specify the name of any connectors to be included in the new app(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. |
Updates & maintenance | You should regularly update and maintain you app(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. |
- | - |
- | - |
- | - |
- | - | - |
Format to PVX Data | Format json to Peoplevox data. |
Strip Data Array | Strips data array for graphQL request. |
Format PVX Event Fulfilment Data | Formats event fulfilment data to line items array. |
Set PVX Time Filter | Sets a time filter variable in Peoplevox format. |
PVX XML to JSON | Formats Peoplevox data into json. |
PVX Returns Combine Report Data Lines | Combines report data by sales order number. |
Calculate Shopify Refunds | Calculates refunds from suggested refund data. |
Flatten Products | Flattens products to one list of variants. |
Generate Sku Query | Generates a Shopify GraphQL query for provided SKUs. |
Calculate Inventory Adjust | Calculates inventoryItemAdjustments. |
Combine Fulfilment Lines | Combines report data by sales order number. |
N/A | This app does not include any cross-reference lookups. |
Stock Event Data | Flow run |
Original Return Data | Flow run |
Original Fulfilment Data | Flow run |
Fulfilment Order Line ID | Flow run |
Order Data | Flow run |
Returns ID | return code |
is the Warehouse Management System for eCommerce businesses, online retailers and direct to consumer brands.
is a cloud-based, fully hosted commerce platform which can be used to create and manage online stores.
by Amazon is multichannel shipping software with discounted rates, automation and inventory control.
is an eCommerce solution integrated within TikTok, enabling merchants and creators to showcase and sell products.
Adobe Commerce (powered by Magento) is a flexible, scalable commerce platform that lets you create uniquely personalised B2B and B2C experiences.
Aero Commerce is a performance-based platform that's extendable and scalable, providing bespoke, personalised eCommerce stores for retailers.
Airtable is a single platform which empowers teams to build custom apps on top of shared data.
Akeneo is a product information management and product data intelligence solution.
Algolia is a search-as-a-service API that focuses on providing the best experience for end users.
BigCommerce is a cloud-based eCommerce platform that provides software as a service to retailers.
Bleckmann provides a seamless logistics process, from warehousing and inventory management to order fulfilment.
Bloomreach Engagement is an eCommerce platform specialising in marketing automation, product discovery, and content management systems.
Brightpearl is a Retail Operating System (ROS) for retailers and wholesalers.
Microsoft Dynamics 365 Business Central is a cloud-based ERP solution.
Centra is a commerce platform for fashion & lifestyle brands.
ChannelEngine ensures product info and stock levels are synchronised across marketplaces.
Cin7 is a fully integrated, cloud-based inventory management solution.
Clarus WMS is a leading provider of warehouse management systems for businesses.
Clerk.io is an e-commerce personalisation platform that helps e-commerce businesses analyse customer behaviours.
Commerce Layer is an API-first commerce engine that makes it easy to incorporate full eCommerce functionality into your existing tech stack.
commercetools provides all composable components needed to build and run shopping experiences.
Cybertill is a cloud-based retail software provider which incorporates eCommerce, stock control, CRM, merchandising and warehousing modules.
Deposco is an inventory management system for retail, eCommerce, DTC & 3PL users.
Peoplevox is the Warehouse Management System for eCommerce businesses, online retailers and direct to consumer brands.
Dotdigital integrates with key business systems to enable data-driven, automated campaigns and rich, real-time insights.
EdiFabric is a developer SDK and API used to parse, generate, validate, split, acknowledge, represent, view, and document EDI files.
EKM Insight is a leading managed print service (MPS) software supplier, helping customers optimise their print and imaging operations.
Emarsys is a customer engagement platform that helps marketers in a range of industries deliver personalised experiences.
EVA's cloud-based solution combines (m)POS, e-commerce, clienteling, order management, and inventory & fulfillment.
Flexport focuses on supply chain management and logistics, including order management, delivery, trade financing, insurance, freight forwarding and customs brokerage.
Fluent Commerce a leading order management system which optimises fulfillment and solves inventory visibility issues.
Freshdesk is a cloud-based customer engagement solution for streamlining customer support.
The Patchworks FTP connector can be used to connect your SFTP servers for use in process flows.
Fulfillmenttools is a SaaS solution, which handles all key fulfillment processes.
Google BigQuery is a fully managed enterprise data warehouse that helps you manage and analyse your data.
Google Pub Sub is used for streaming analytics and data integration pipelines to load and distribute data.
Google Sheets is whatever you want it to be! Retrieve and update data from your sheets as needed.
Gorgias is a customer support platform built for eCommerce companies.
GXO Logistics is a leader in cutting-edge warehousing and distribution - designing, managing, and optimising supply chains and delivering customised, tech-enabled solutions.
Happy Returns (by PayPal) is a software and reverse logistics company that works with online merchants to handle product returns.
Huboo is an eCommerce fulfilment partner, helping businesses of all sizes scale using third party logistics (3PL).
HubSpot is a CRM platform with software integrations and resources to connect marketing, sales, content management, and customer service.
InPost provides a network of Automated Parcel Machines (APMs) across the UK, allowing customers to send, return, and collect parcels.
Inriver is an SaaS provider specialising in product information management, transforming product information into a profit-making asset.
Jira (developed by Atlassian) is a software solution that allows bug tracking, issue tracking and agile project management.
Klaviyo provides a marketing automation platform, used primarily for email marketing and SMS marketing.
Lightspeed X-Series (Vend) is a retail POS, inventory management, and eCommerce solution.
Linnworks is an eCommerce inventory and order management platform that helps retailers automate key processes.
LionWheel is a delivery management software and route optimisation application that integrates with all major eCommerce and ERP platforms.
Mailchimp is a marketing automation and email marketing platform.
Mailjet is a cloud-based email delivery and tracking system which allows users to send marketing and transactional emails.
The Marketplacer - Operator API is used to build integrations into existing eCommerce platforms.
The Marketplacer - Seller API is used by sellers to automate the processes required for selling their products on a Marketplacer marketplace.
MongoDB is a flexible, scalable document database.
Mirakl eCommerce software provides online marketplace software to retailers, manufacturers and wholesalers.
NetSuite is a cloud-based solution that helps businesses manage all aspects of their operations.
Occtoo is an Experience Data Platform that helps marketers consolidate information about products, consumers & purchasing behaviours.
Octopus Energy is a British renewable energy group specialising in sustainable energy.
Odoo is a suite of open source business apps covering CRM, eCommerce, accounting, inventory, point of sale, project management, and more.
Ometria is a customer data and experience platform for retail.
OnBuy is an online marketplace connecting buyers with business sellers (and vice versa).
OpenAI is an artificial intelligence research organisation that focuses on developing advanced AI technologies and models.
OrderWise is an integrated ERP system that connects business functions, enabling customers to take control across all stock and order activity in a single system.
PagerDuty is a SaaS incident response platform, delivering visibility and intelligence across the entire lifecycle of incidents.
Pimberly is a Product Information Management platform, helping with all aspects of product data processing.
Plytix is a Product Information Management (PIM) solution which helps to distribute product information anywhere online.
Prima Solutions provide enterprise resource planning software including order management, stock control, product development, retail & eCommerce.
Quickbooks is a cloud-based accounting solution.
RabbitMQ is a popular, open-source message-broker.
Rebound is a returns management specialist, enabling easy omnichannel returns for retailers and consumers.
ReturnGo is a self-service return management portal that allows customers to return and exchange products.
Returnless is an all-in-one returns platform to handle returns faster, lower costs and prevent future returns.
Reveni helps eCommerce merchants provide instant refunds and exchanges for their customers.
REVIEWS.io is a review collection and management tool that helps businesses grow their online reputation.
Sage is the market leader for integrated accounting, payroll, and payment systems
Salesforce Commerce Cloud enables businesses to set up eCommerce sites, drive more automation and provide customers with seamless shopping experiences.
Salsify provides Product Experience Management (PXM) software for online sellers, allowing brands to centralise their listing content and publish to multiple endpoints.
Sanity.io provides a modern CMS that transforms content into a competitive advantage.
SCAYLE is a commerce engine enabling brands and retailers to scale their business across technology, operations, and online marketing.
SEKO provides complete supply chain solutions, specialising in transportation, logistics, forwarding and warehousing.
The Patchworks SFTP connector can be used to connect your SFTP servers for use in process flows.
ShipBob is a global fulfillment solution used by brands to ship orders from everywhere their customers shop.
Shiptheory is an online platform that allows businesses to integrate with channels and carriers to automate shipping processes.
Shopify is an eCommerce platform for businesses to create and manage their online stores in a highly tailored way.
Shopline is an eCommerce platform for businesses to create and manage their online stores.
Shopware is an integrated tool for marketing and creating online shops.
Sitoo is a cloud-based POS and unified commerce platform for global retailers.
Snowflake provides a single platform for data warehousing, data lakes, data engineering - together with secure sharing and consumption of real-time / shared data.
SparkLayer enables powerful B2B ordering on major eCommerce platforms.
Stok.ly provides seamless, multi-channel and multi-location order and warehouse management for retailers and wholesalers.
Swap Commerce combines seamless returns experiences with flexible financing to help businesses scale.
Tempo project, product, & portfolio management solutions are designed to enhance Jira by helping teams collaborate, plan, budget, track, and work smarter.
The Edge by John Lewis is a modular SaaS platform that sits between the retailer and their suppliers.
TikTok Shop is an e-commerce solution integrated within TikTok, enabling merchants and creators to showcase and sell products.
Torque are eCommerce supply chain specialists, offering comprehensive solutions and services to optimise supply chains, from warehouse to doorstep.
Trello is a web-based, kanban-style, list-making application and is developed by Trello Enterprise, a subsidiary of Atlassian.
Twilio's customer engagement platform combines flexible APIs for any digital channel.
Veeqo by Amazon is multichannel shipping software with discounted rates, automation and inventory control.
Virtualstock is a modular SaaS platform that sits between the retailer and their suppliers.
Visual Next is a leading software solutions provider tailored to the apparel, footwear, uniform, sportswear and fashion accessories industry.
Visualsoft provides an end-to-end eCommerce platform with performance-driven digital marketing services.
Voyado is a customer experience platform helping retailers with marketing automations, loyalty schemes, campaign management, and more.
Whistl is the UK's leading logistics company, specialising in fulfilment, contact centres, mail and parcel delivery management.
WooCommerce (Woo) is an open-source eCommerce platform for Wordpress websites.
Xero provides cloud-based accounting software for small businesses.
Zendesk provide software-as-a-service products related to customer support, sales, and other customer communications.
ZigZag is a market-leading global returns solution provider.