Initialising a process flow & sending data via the Patchworks API

To view this content in our official product documentation, click here.

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:

Stage #	Action	Tool
1	Prepare your data	Your preferred text editor
2	Map your payload data	Patchworks dashboard (process flows)
3	Obtain the process flow ID & version for API requests	Patchworks dashboard (process flows)
4	Obtain a token for Patchworks API authentication	Postman
5	Initialise a process flow and send data via the Patchworks API	Postman

In this guide we're using Postman for API calls - you can use your preferred tool for these steps.