JSON format documentation

This section covers the JSON format utilized for data transfer within journeys on Quickwork.

JavaScript Object Notation (JSON) is a lightweight data-interchange format that is easy to read and write for humans and simple to parse and generate for machines. It is based on a subset of JavaScript and involves pairs of keys and corresponding values.

The key components are:

  • Keys: Always a string enclosed in double quotes.
  • Values: Can be a string, number, JSON object, array, boolean (true/false), or null.

Examples of JSON structures

  • Single object with key-value pairs:
    {"OrderID":"O1001"}

Description: Represents a simple object with one key-value pair where "OrderID" is the key and "O1001" is its value.

  • Object with multiple with key-value pairs:
{"OrderID":"O1001","Customer":"John Doe","Quantity": 3,  "Status": "Processed"}

Description: A more complex JSON object containing several keys that store information about an order.

  • Array of objects:
    [  
            {"OrderID":"O1001","Customer":"John Doe"},  
            {"OrderID":"O1002","Customer":"Jane Smith"}  
          ]
    Description: An array containing multiple objects, each representing a distinct record or item.
  • Nested JSON objects:
{  
     "Order": {  
     "OrderID": "O1001",  
     "Customer": "John Doe",  
     "Details": {  
       "Product": "Laptop",  
       "Quantity": 1,  
       "Price": 1200  
       }  
      }  
     }

Description: Demonstrates a nested structure where an object contains another object.

Usage in Quickwork journeys

  • JSON objects are used in Quickwork to pass information between different steps of a journey.
  • These are seen in input fields like Input, Output, Sample Response of HTTP , Google Sheets, and Callable Journey apps.
📘

Quotes: Keys and string values are enclosed in double quotes. Numbers and booleans do not require quotes.

Understanding and using the JSON format effectively allows for robust and flexible data manipulation within Quickwork journeys, supporting a wide range of automation scenarios.

📚 Additional resources

Understanding the query language