Introduction

Patchworks API requests must be authenticated with a bearer token. To obtain a token, you need to send a login request which includes credentials that you use to access the Patchworks dashboard.

The steps

Step 1 Create a POST request for the following endpoint:

https://svc-fabric.pwks.co/api/v1/login

Step 2 In the request body, add the email and password that you use to log into the Patchworks dashboard. You should add this as JSON - for example:

{
    "email": "[email protected]",
    "password": "mypassword123*"
}

Step 3 Send the request - if successful, a token is returned. For example:

Step 4 Save this token ready for use in your initialise request.

Introduction

The Patchworks inbound API supports data within strings. This data must be passed within a payload key.

Required format

The required data format is a JSON object with a payload key containing a string of data. For example:

{
  "payload": "some data" | "<some-xml></>" | "{\"a-stringified-json-payload\": true}"
}

Here, note that the payload key is in a JSON object, and is being used to hold different types of data as strings - text, XML and JSON.

Introduction

All steps required to initialise a process flow via the Patchworks Core API are detailed below. This page provides a quick overview of these steps.

Summary

Introduction

When you send a Patchworks API request to initialise a process flow, you must provide the internal IDs for the required process flow and version. This guide walks through the steps required to obtain this information.

The steps

Step 1 Log in to the Patchworks dashboard.

Step 2 Select process flows from the left-hand navigation menu and select the process flow that you want to update.

Step 3 Check the title bar in the top-left corner and make a note of the number above the title - this is the process flow ID:

Step 4 Click the settings icon:

...to access process flow settings:

Step 5 Look in the versions panel and find the version of this process flow that you want to initialise, then note the associated ID - this is the process flow version ID:

Step 6 You'll use this information later in any API requests made to initialise this process flow.

Introduction

This section walks through the steps required to pass data from your own system into a Patchworks process flow, via the Patchworks API.

Assumptions

To complete these steps it's assumed that you have:

• Registered for a Patchworks account and have a username and password to access your Patchworks dashboard

• Built at least one process flow that you want to update via the Patchworks API

What you need to do

The required steps are detailed in the following stages:

Introduction

If your process flow is sending source data into a target connection, you should map this data using the map shape. This is done in the usual way with two points to note:

• No source details are set

• Mapping rows must be added manually

Source endpoint

In a typical situation, the map shape is used to map data from a source connection to a target connection. However in this scenario, we don't have a source connection - Patchworks doesn't know what data you are sending in or what system it's coming from.

As such, you won't select any source details when configuring the map shape - just leave these field blank:

Add mapping rules manually

Because Patchworks has no way of knowing the structure of your incoming data, mapping rules must be added manually.

For further guidance please see our Working with field mappings page.

Introduction

Having obtained a Patchworks token, it can be applied to an API request to initialise a process flow with your data passed in the request body.

The steps

Step 1 Create a POST request for the following endpoint:

https://start.wearepatchworks.com/api/v1/flows/<flowID>/manual/<flowVERSION>

...replacing <flowID> and <flowVERSION> with details for your required process flow noted previously.

Step 2 In the request headers, pass in the token obtained previously - this should be prefixed with the word Bearer - for example:

Step 3 In the request body, pass in the required payload - for example:

{
  "payload": "[{\"id\":1000000001,\"first_name\":\"Jane\",\"last_name\":\"Smith\"},{\"id\":1000000002,\"first_name\":\"George\",\"last_name\":\"Jones\"}]"
}

Step 4 Send the request - if successful, a 200 'flow initialised' response is given, together with a flow run id: