Preparing your data

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

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:

{% code lineNumbers="true" %}

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

Non-strings and raw payloads are not currently supported.

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.