Skip to content

JSON parser

How-to7 minExpert

Before you start

A JSON parser reads JSON text and makes its fields available to the steps below. Use it when a webhook sends an order, or a field holds a reply you saved earlier.

When should I use the JSON parser?

Section titled “When should I use the JSON parser?”

Use it for JSON you already have. If you are calling another system, a REST API step reads the reply for you with the same shape builder. For CSV files, use the CSV parser.

Add a JSON parser

Section titled “Add a JSON parser”
  1. Click + and choose JSON parser. It sits in the Data group.
  2. Under Read, choose The data the webhook sent or A value. For a value, insert the field that holds the JSON text.
  3. Under Its shape, click Add a field for each piece you need, or open Paste a sample and click Build the fields from it.
  4. Under Result, type a name in Name it.
A JSON parser step selected, with Read set to The data the webhook sent, a shape of three fields and a result name.
    Read chooses where the JSON text comes from.
    Its shape lists the fields to keep, with a type for each.
    Name it names the result for the steps below.

What do the settings do?

Section titled “What do the settings do?”
SettingWhat it does
The data the webhook sentReads the body of the webhook that started the workflow
A valueReads JSON text from a field or a result
Its shapeThe fields to keep. Types: Text, Number, Decimal, Date, Yes/No, Object, List of objects, List of values
Paste a samplePaste an example, click Build the fields from it. Objects and lists are picked up
Name itThe name later steps use for the result

Under the shape, a short table shows how later steps reach each kind of field in Insert data.

Worked example: read a vendor webhook

Section titled “Worked example: read a vendor webhook”

A vendor portal posts a bid as JSON to Nour’s webhook workflow. She chooses The data the webhook sent, pastes a sample bid and clicks Build the fields from it. She names the result bid. A later Record manager reads bid › Amount.

What should I watch for?

Section titled “What should I watch for?”
  • The text must be one JSON object.
  • Use the Number type only for fields that hold numbers.
  • A list of plain values arrives as rows with one field named after the list. In a Loop, each round’s value is Current item › the list’s name.
  • An object’s fields arrive as parent_field on the record, and as a one-row list.

Check yourself

A JSON reply has 10 keys and you list 4 under Its shape. What reaches later steps?
Show the answer

Only the 4 you listed. Only the fields listed under Its shape reach later steps. Anything else in the JSON is dropped.

What shape of JSON text do you give the parser?
Show the answer

One JSON object. Give the parser one JSON object, and describe its fields under Its shape.

What's next

CSV parserRead the rows of a CSV file held in a file field into a list, with the columns you name and their types.LoopRepeat the steps inside a loop for each record of a list, each item inside a field, or a set number of times.

Last checked