Payload Builder step

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read
    • Summarize
    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 enables action designers to create name-value pairs in JSON and XML formats using dynamic data. This functionality is part of the Action Designer actions and is available to users with the actiondesigner role. Note that this step has been deprecated for JSON in favor of the JSON Builder step.

    Show full answer Show less

    Key Features

    • Name Value Pairs: Users can add name-value pairs to the payload, where the Name serves as a key in JSON and an element in XML.
    • Omit if empty: Option to exclude name-value pairs if their values are empty or null, accessible via advanced options.
    • Output Format: Users can select either JSON or XML for the payload format.
    • Namespace: Allows for the specification of XML namespaces when the output format is set to XML.
    • Include Outer Structure: Option to include a top-level container in the payload depending on the chosen format.
    • Send Empty Structure: Enables sending a valid JSON or XML structure even when the payload is empty.
    • Parent Node: Defines the XML element that contains the name-value pairs when the output is set to XML.
    • Preview: Provides a read-only view of the payload produced by the step.
    • Action error evaluation: Options for handling errors during execution, including decisions on whether to continue or evaluate errors based on step status codes.

    Key Outcomes

    By utilizing the Payload Builder step, ServiceNow customers can efficiently construct dynamic payloads for their actions, ensuring compatibility with both JSON and XML formats. This flexibility aids in integrating with various systems and enhances data handling capabilities in workflows.

    Enable action designers to easily create name-value pairs in JSON and XML payloads using dynamic data.

    Roles and availability

    Available as an Action Designer 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.

    Fields

    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: short_description
    • Value: [action]->[short_description]
    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.
    Namespace The XML namespace to apply to each element. For example, when the namespace is set to incident:
    <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.

    Action error evaluation

    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 Action error evaluation.