Building your own connector

Introduction

The connector builder walks you through a series of configuration pages so you can complete all required setup that's needed to make your connector available in Patchworks.

Once your connector is built, it is displayed in the Patchworks marketplace, so users associated with your company profile can add instances of it.

Prebuilt connectors must be installed before instances can be added for them. However, when you build your own connector it's automatically installed, ready for instances to be added.

Preparation

Before you start work with the connector builder, make sure that you have the API documentation to hand for whichever third-party application you're building.

We also recommend that you fire up Postman, so you can test any API requests that you're adding to the connector builder.

Required setup

As you step through the connector builder, you are prompted to complete the following configuration steps.

Make sure that you have the API documentation to hand for whichever third-party application you're building!

Basic details

Provide a name and other basic details for your new connector. For guidance on completing this page please see 1: Basic details.

Variables

Add variables that you might use in multiple places in your connector setup (i.e. variables used for authentication method and endpoint configuration). For guidance on completing this page please see 2: Connector variables.

Authentication methods

How would you like users to authorise any instances that they add for this connector? Every connector requires at least one authorisation method. For guidance on completing this page please see 3: Authentication methods.

Endpoints

Define the API requests for any endpoints you want to make available for this connector. For example, if you want to pull/push products then you'll need a 'products' endpoint; if you want to pull/push orders then you'll need an 'orders' endpoint, etc. For guidance on completing this page please see 4: Endpoints.