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

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# Payload Builder step

# Payload Builder step {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 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 Payload Builder step

The Payload Builder step in Workflow Studio enables action designers to create dynamic name-value pairs formatted as JSON or XML payloads.
It allows embedding dynamic data using data pills, facilitating integration and automation workflows.
Note that for JSON payloads, this step is deprecated and replaced by the JSON Builder step.
Show full answer Show less  

## Key Features

* **Name Value Pairs:** Add multiple name-value pairs where the name becomes a JSON key or an XML element. Values can include dynamic data references.
* **Omit if Empty:** Optionally exclude name-value pairs from the payload if their values are empty or null, helping to keep payloads concise.
* **Output Format:** Choose between JSON or XML formats for the payload output.
* **Namespace (XML only):** Define an XML namespace prefix applied to each element for better XML schema compliance.
* **Include Outer Structure:** Option to wrap the payload in a top-level container element or JSON object, which can be customized for XML parent node naming.
* **Send Empty Structure:** Decide whether to send an empty but valid JSON or XML structure when no name-value pairs have values, or send an empty payload.
* **Preview:** View the generated payload output in read-only mode directly in the step interface to verify correctness before execution.
* **Action Error Evaluation:** Configure how the workflow behaves if the Payload Builder step fails, with options to continue or trigger error evaluation.

## Practical Use for ServiceNow Customers

This step is useful for customers creating automated workflows that need to construct structured JSON or XML messages dynamically, such as for integrations with external systems or APIs. It simplifies building and customizing payloads with dynamic ServiceNow data, while offering flexibility to handle empty values and control payload structure. Understanding the available fields and options ensures accurate payload formation aligned with target system requirements.  
Enable action designers to easily create name-value pairs in JSON and XML payloads using dynamic data.

## Roles and availability {#payload-build-step-action-designer__section_g2v_5jq_2fb}

Available as an Workflow Studio action step. Users with the action_designer role can create a custom action with one or more action steps.  
Note:  
For JSON, this step is deprecated and replaced by the [JSON Builder step](https://www.servicenow.com/docs/7pYqudqKWAfHH6znUnRWJA "Create a JSON payload to use in another step. Enter values or use data pills to produce a dynamic payload. This step supports several data types, including objects and arrays for nested structures.").

## Fields {#payload-build-step-action-designer__section_fhk_zjq_2fb}

{#payload-build-step-action-designer__table_hqc_ckq_2fb__entry__2}

| Fields | Description |
|-|-|
| Name Value Pairs | The name-value pairs to include in the payload. Click the plus icon to add name-value pairs. Drag data pills into either field to produce dynamic payloads. The Name becomes a key in JSON and an element in XML. For example, suppose you create this name-value pair. * Name: <kbd class="ph userinput">short_description</kbd> * Value: <kbd class="ph userinput">[action]-&gt;[short_description]</kbd> {#payload-build-step-action-designer__ul_vcy_kmq_2fb} When the system formats the name-value pair as JSON: "short_description": "[action]->[short_description]" When the system formats the name-value pair as XML: <short_description>[action]->[short_description]</short_description> |
| Omit if empty | The option to exclude a name-value pair if the value is empty or null. Note: This field is only visible after clicking the down arrow to display advanced options. |
| Output Format | The payload file format. * JSON: Select to format the payload as a JSON document. * XML: Select to format the payload as an XML document. {#payload-build-step-action-designer__ul_gbf_3kq_2fb} |
| Namespace | The XML namespace to apply to each element. For example, when the namespace is set to <kbd class="ph userinput">incident</kbd>: <incident:short_description>[action]->[short_description]</incident:short_description> Note: This field is only visible when the Output Format is set to XML. |
| Include Outer Structure | The option to include or exclude a top level container appropriate to the output format. When the Output Format is JSON, curly braces contain the name-value pairs. When the Output Format is XML, a specified XML element contains the name-value pairs. For example, when the system formats the name-value pair as JSON: { "short_description": "[action]->[short_description]" } When the system formats the name-value pair as XML: <xml> <short_description>[action]->[short_description]</short_description> </xml> |
| Send Empty Structure | The option to send valid JSON or XML structures when the payload is empty. Enable this option to include JSON or XML structural text in the payload. For example, when the system formats an empty structure as JSON: {} When the system formats an empty structure as XML: <xml></xml> Disable this option to produce an empty payload. Empty payloads can occur when you select the Omit if empty option for every name-value pair, and all name-value pairs in the payload produce empty values. |
| Parent Node | The name of the XML element that contains the name-value pairs. The default parent node element is `xml`. Note: This field is only visible when the Output Format is set to XML and the option to Include Outer Structure is enabled. |
| Preview | The read-only payload the step produces. |
[ ]

{#payload-build-step-action-designer__table_hqc_ckq_2fb}

## Action error evaluation {#payload-build-step-action-designer__id_lg2_4s3_15b}

If this step fails
:   Data type: Choice

    Option to continue running the next step or go to error evaluation. To use the step status code or message for a custom action error condition, see .