---
sourceDocument: Brazil Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# JSON parser step

# JSON parser step {#ariaid-title1}

Release version: Brazil  
Updated September 10, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of JSON parser step

The JSON parser step in ServiceNow Workflow Studio enables you to identify and map structured data from JSON payloads without scripting.
It converts incoming JSON content into a complex object output, which can then be used in subsequent workflow steps or actions.
This step requires an Integration Hub subscription and supports payloads up to 10 MB at runtime.
For larger payloads, Data Stream actions are recommended.
Show full answer Show less  

## Key Features

* **Source Data:** Select or drag a data pill containing the JSON payload (e.g., REST step response body). Use example JSON payloads (up to 2 MB) to generate the output structure.
* **Structured Payload View:** Toggle between raw JSON and a structured node tree to visualize and copy JSONPath for mapping elements.
* **Generate Target:** Automatically creates the output complex object structure based on the example payload. Child elements default to String type.
* **Manual Target Editing:** Allows adding or editing elements with attributes such as label, name, data type (String, Object, Array.String, Array.Object), mandatory flag, and advanced options like max length, hints, and default values.
* **JSONPath Customization:** Modify JSONPath mappings to control how source JSON data maps to output elements.
* **Template Saving:** Object-type elements can be saved as complex object templates for reuse in action schemas.
* **Payload Limitations:** Does not support multidimensional arrays or JSON keys with hyphens, periods, spaces, double colons, or @ symbols.

## Practical Example

To synchronize newly created problems from a production instance to a test instance as defects:

* Create an action named **Parse Problems from Production** that includes a REST step to fetch problems and a JSON parser step to convert the response body into a complex object matching the Problem table schema.
* Create an action output of type Object to hold parsed problems.
* Create a flow named **Sync New Problems** triggered daily. This flow calls the parsing action, iterates over the parsed problems, checks for problems in the new state, and creates corresponding defect records in the test instance.

## What This Enables You To Do

ServiceNow customers can efficiently parse and manipulate JSON payloads within workflows without coding custom scripts, simplifying integration with REST APIs and external data sources. The JSON parser step streamlines data transformation, enabling complex object outputs that integrate smoothly into flows and actions, which enhances automation and data synchronization capabilities across instances and systems.  
Identify structured data from a JSON payload without having to write a script. Map incoming JSON content to a complex object output that you can use in other steps or actions. At runtime, values from a JSON payload populate the complex object output.
To learn more about complex objects, see Complex data.  
Note:  
This step requires an Integration Hub subscription. For more information, see [Legal schedules - Integration Hub overview](https://www.servicenow.com/content/dam/servicenow-assets/public/en-us/doc-type/legal/snc-addendum-integrationhub.pdf). After the required plugin is activated, the step is visible under Integrations.

## Roles and availability {#json-parser-step-action-designer__section_pwq_rb5_kcb}

Available as an Workflow Studio action step. Users with the action_designer role can create a custom action with one or more action steps.

## Payload size limit {#json-parser-step-action-designer__section_tps_xtd_kdb}

At runtime, JSON parser step
supports payloads up to 10 MB. For larger payloads, create a Data Stream action. For more information on Data Stream actions, see [Data Stream actions and pagination](https://www.servicenow.com/docs/Gz~ri5FHBHZ5R3Tw7AIBaQ "Send REST, SOAP, or JDBC requests from Workflow Studio to APIs that return a stream of response data larger than 10 MB, or that return paginated results. Parse stream data into a series of complex object outputs and use the data pills in other actions in a flow.").

## Fields {#json-parser-step-action-designer__section_cbz_tj5_kcb}

{#json-parser-step-action-designer__table_d1v_xtr_tgb__entry__2}

| Field | Description |
|-|-|
| Source | In the Source data field, select or drag a data pill that contains the source JSON payload. For example, a REST step Response Body data pill. At runtime, values from the data source populate the complex object output. Under Source data and in the scripting window, enter an example payload to generate your complex object. For example, if parsing the response from a [REST step](https://www.servicenow.com/docs/KRtKD0C8bXSYxWpVvOd64w "Send an outbound REST web service request to an external system.") that returns a list of users, enter the expected JSON object for a single user. You can create any example JSON payload with the following limitations: * Multidimensional arrays are not supported. * Hyphens, periods, spaces, double colons, and the @ symbol in JSON keys are not supported. * Your example payload can't exceed 2 MB. {#json-parser-step-action-designer__ul_r1s_xxc_jhb} |
| Structured Payload View | View your example payload as regular JSON, or toggle Structured Payload View to view the payload in a structured node tree. Select a node in the tree to copy the element's JSONPath. If you add new elements in the Target field manually, you can paste this JSONPath under an element's advanced options. |
| Generate Target | Select Generate Target to create the step's output structure from your example payload. Your output data structure appears in the Target field. Child elements for each object are automatically generated as type String. Alternatively, you can manually create your target complex object by adding elements in the Target field. |
| Target | View or edit the JSON payload's output structure. Create a structured output by clicking Generate Target, or manually add elements. Each element contains the following information in the Edit Object view: * Label: Data pill label. By default, the system uses the JSON key name. * Name: Internal name for the output element. Note: Exclamation marks, double colons, the @ symbol, or numbers only aren't valid values for an element's name. * Type: Data type, which must be String, Object, Array.String, or Array.Object. The top-level element must be an Object. * Mandatory: Toggle to make the element required. This only applies to elements of type String. * Add child item: Select the add child item icon (![Add child item icon]()) to add a nested child element. {#json-parser-step-action-designer__ul_akv_pzt_tgb} Elements of type Object contain the Save as Template advanced option, which allows you to save your object's structure as a complex object template. You can then use this template to define the schema of an Object output for your action. For elements of type String, you can also add a max length, hint, and default value as advanced options. In the Target header, select Exit Edit Mode when you're done making changes to your output's structure. You can then select the toggle advanced inputs icon (![Toggle advanced inputs icon]()) to view the JSONPath option. The JSONPath is the path to the element. Modify the JSONPath to change how your source data elements map to elements in your output. If manually adding elements, you can copy the JSONPath from a node in your example payload and paste it under an element's advanced options. |
[ ]

{#json-parser-step-action-designer__table_d1v_xtr_tgb}

## JSON parser step example {#json-parser-step-action-designer__section_rtc_mf5_flb}

This example tracks newly created problems from a production instance as defects in a test
instance. First, create a new action named Parse Problems from Production. Add a REST step to retrieve a list of problems from the production
instance. Then, add the JSON parser step to parse the REST step's Response Body and provide a complex object output that represents the Problem \[problem\]
table's schema. Finally, create an action output of type Object named Problems from Production. Drop the root data pill from the JSON
parser step into this output's value field.  
Figure 1. Parse Problems from Production action

Next, create a new flow named Sync New Problems, which is triggered
daily at midnight. The first action in the flow is the Parse Problems from Production action. Then, add a For Each flow logic block
and drop the Problems from Productionresponse data pill into the Item field. Within the
For Each block, add an If flow logic block
that checks if each problem's state is new, then creates a defect record in the test
instance whose assignment group and short description is mapped to each new problem from the
production instance.  
Figure 2. Sync New Problems flow

*[\>]: and then