Adding an instance
Introduction
Once a connector is installed (or built with our connector builder), it's available on your manage connectors page. From here, you can add any required instances.
Every instance requires authentication credentials that allow you to access the associated third-party application - you'll need these to hand before starting the steps detailed on this page. 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 steps
To add an instance for one of your installed connectors, follow the steps below.
Step 1 Log in to the Patchworks dashboard and select process flows > connectors & instances to access the manage connectors page.
Step 2 Find the required connector.
If you can't find the connector here, it means the connector is not installed. In this case, navigate to the Patchworks marketplace and install the required connector.
Step 3 Click the add new instance button:
Step 4 The new instance wizard is launched - enter a name for this instance, then click the next step button:
The name entered here is what your users will see when they choose an instance to associate with connector shapes in process flows. It's advisable to ensure that the name reflects what this instance is for (e.g. Shopify - UK, for a UK instance of a connector).
Step 5 Update settings as appropriate - settings defined here take effect wherever this instance is configured in process flow connector shapes:
Available options are summarised below:
| Option | Summary |
|---|---|
Time zone | Used to convert the time in any date/time filters that are applied when this instance is used in process flows. |
Date format | The expected date format when this instance is used in process flows. |
Rate limit amount Rate limit unit | Determines the rate at which Patchworks is allowed to make API requests to the associated system when using this instance of the connector. If the rate limit for an instance is exceeded, remaining requests are queued and sent when the rate limit is released again. Default settings are provided but you may need to adjust this to suit your specific needs. For example, you might have a plan which allows you a higher rate limit, or you might have multiple instances for the same connector running at the same time, which all need to share a rate limit. If you're not aware of any specific requirements, leave the default settings as they are. |
Connection pool | If the connector associated with this instance has a concurrency limit and you have configured connection pools, these are available for selection here. For more information see our Connection pools page. |
Step 6 Choose which authentication method you wish to use for this instance, then click the next step button:
Any authentication methods defined for the underlying connector will be available for selection. Often there will only be one however, if multiple authentication methods are shown, choose the one associated with the credentials that you have available.
Step 7 Enter valid credentials for this instance, then click the next step button:
Only valid credentials can be saved. Required credentials will vary, depending on the selected authentication type. Any fields that are shown in the advanced section are not typically required for standard use.
.svg?alt=media&token=ddeb7ae5-d7c7-46f5-baf3-55a3d5b1478f)
Invalid credentials
If the credentials that you provide can't be validated, you'll see a failure notification at the top of the page and a view details button is displayed at the bottom - for example:
Click the view details button to view details for the authentication request and response:
The request tab confirms any information that is being passed for validation, and the response tab shows response information for the authentication request. Here you'll see a response code, body content (typically the failure message associated with the response code) and header details.
Step 8 The instance is created for the associated connector and is now shown on the manage connectors page - for example:
Once an instance is added, it becomes available for selection in connection shapes when you build process flows.
Last updated