Quickstart guide

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.

Last updated 8 months ago

Prepare your data

If you're passing in a payload via the request body, it must be stringified within a JSON object. For example:

{
  "payload": "{\"a-stringified-json-payload\"}"
}

Authenticate

To obtain a Patchworks token for API authentication, send a POST request to the following URL:

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

This request must include your Patchworks login credentials in the body:

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

Initialise flow

To initialise a process flow, send a POST request to the following URL:

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

Replacing <flowID> and <flowVERSION> with details for your required process flow noted previously, and authenticate with your Patchworks token.