You can now work with our API reference, right here!
Take me there
Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Adding an instance

Introduction

Once a connector is installed or built using our connector builder, it becomes 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.

1

Access your connectors

Log in to the Patchworks dashboard and select process flows ➤ connectors & instances to access the manage connectors page.

2

Launch the instance setup wizard for your connector

Locate the required connector and click the add new instance button. For example:

3

Launch the instance setup wizard for the required connector

Enter a name for this instance, then click the next step button. For example:

The name entered here is what your users will see when they choose an instance to associate with connector shapes in process flows.

4

Review & update connector details

Review the default connector details and update where appropriate - then click the next step button:

The 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.

5

Select how this instance should be authenticated

Choose which authentication type you wish to use for this instance, then click the next step button:

All authentication methods defined for the underlying connector are available for selection. Often, there will only be one; however, if multiple authentication types are shown, choose the one associated with the credentials that you have available.

6

Provide credentials

Enter valid credentials for this instance and click create. For example:

Only valid credentials can be saved. Required credentials will vary, depending on the selected authentication type. If you see an advanced section, it's worth reviewing these settings, though typically, these fields don't need to be changed for standard use. If required, you can also upload authentication certificates.

Currently, p12 certificates are supported.

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. For example:

The request tab confirms any information 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.

7

The instance is ready for use

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.

PreviousAccessing instances
NextUpdating an instance

Last updated

Was this helpful?