---
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


---

# OpenAPI/Postman step

# OpenAPI/Postman step {#ariaid-title1}

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

The OpenAPI/Postman step in ServiceNow Integration Hub allows you to import OpenAPI specifications (v2.0 or v3.0) or Postman collections (v2.0.0 or v2.1.0) of third-party outbound REST web services and build integrations based on them.
This step automatically derives REST API request details from the imported specifications or collections and generates complex data object outputs for JSON responses.
It requires the Integration Hub subscription and activation of the related plugin.
Show full answer Show less  

## Key Features

* **Action Designer Integration:** Available as an action step for users with appropriate roles (actiondesigner and openapiadmin or admin) to create custom actions.
* **Connection Alias:** Uses connection aliases to manage credentials and connection information across environments efficiently.
* **Configurable Request Details:** Advanced view lets you customize resource path, HTTP method, query parameters, headers, and outputs.
* **API Source and Operations:** Select APIs and specific operations directly from imported OpenAPI specs or Postman collections.
* **Query Parameters and Headers:** Supports manual creation or dynamic assignment of parameters and headers, including duplicates, preserving their order.
* **Attachment Support:** Attach binary data to requests using JSONStreamingBuilder or XMLStreamingBuilder APIs.
* **Retry Policy:** Enables configurable retry policies per request, with options to override default policies.
* **Error Handling:** Defines whether to continue or evaluate errors on step failure, supporting custom error conditions.

## Known Limitations

* Request body supports only JSON media types.
* The step supports some but not all OpenAPI 3.0 components; unsupported components include discriminator objects, callback objects, security schemes, tags, external docs, servers, and others.
* OpenAPI schema with `additionalProperties` or no defined properties results in a string type output object.
* The maximum supported number of API operations defaults to 500 but can be adjusted up to 1000 via system property `glide.rest.openapi.maxoperationlimit`.

## Practical Benefits for ServiceNow Customers

This capability streamlines integration with external REST APIs by leveraging existing OpenAPI or Postman definitions, reducing manual configuration effort. It ensures consistent, reusable connection management through aliases, supports complex request customization, and handles JSON responses effectively. Customers gain control over error handling and retries, enhancing robustness of integrations. Awareness of current limitations helps plan usage and avoid unsupported features.  
Import the OpenAPI specification or a Postman collection of a third-party outbound REST web service and build an integration to the web service. The request details for the underlying REST API operation are derived from the
OpenAPI specification or Postman collection.
For JSON output response body, the system creates a complex data object output from the OpenAPI specification or [Postman collection](https://learning.postman.com/docs/collections/collections-overview/).  
Note:  
OpenAPI/Postman step is not available in the base system and requires the ServiceNow® Integration Hub subscription. After the required plugin is activated, the step is visible under Integrations.

## Roles and availability {#open-api-step-action-designer__section_nqy_t5t_txb}

Available as an Action Designer action step. Users with the action_designer and open_api_admin, or admin roles can create a custom action with one or more action steps.

## Fields {#open-api-step-action-designer__section_wqf_w5t_txb}

{#open-api-step-action-designer__table_z5z_y5t_txb__entry__2}{#open-api-step-action-designer__field-connection-alias}{#open-api-step-action-designer__xml-stream}

| Field | Description |
|-|-|
| Connection Alias | Connection \& Credential alias record that the system uses to run the action step. Users with the action_designer and connection_admin, or admin roles can select an associated Connection alias record. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using an action in multiple environments. Likewise, if the connection information changes, you don't need to update your custom action. To learn more about connections and credentials, see [credentials, connections, and aliases](https://www.servicenow.com/docs/access?context=credentials-connections-alias&version=australia&pubname=australia-platform-security&ft:locale=en-US). |
| Base URL | Base URL from the Connection Alias for the REST request. |
| Toggle Advanced View | Option to view or hide the request details. When enabled, you can view and configure the resource path, HTTP method, query parameters, headers, and action outputs of the request. |
| API Source | Option to select an API from the list of available imported APIs. |
| Import Spec | Option that allows you to import an OpenAPI (v2.0 or v3.0) specification or a Postman collection (version 2.0.0 or 2.1.0). You can import an OpenAPI specification or Postman collection by providing a URL and credentials to the specification or collection, or manually copying and pasting JSON content. |
| API Operation | Option to select an operation from the list. Available operations are provided by the OpenAPI Specification or Postman collection in the API Source field. |
| Save As Attachment | Option to specify whether to save the response as a record in the Attachment \[sys_attachment\] table. |
| Resource Path | Path for the resource. |
| HTTP Method | HTTP method used to process the request. * GET * POST * PUT * PATCH * DELETE {#open-api-step-action-designer__ul_ivc_211_lbb} |
| Query Parameters | Name-value pairs to pass to the REST endpoint. You can create these parameters manually, or drag input variables into the parameter fields, and then assign a value. Support REST step requests that contain duplicate query parameter names. If you create a REST request that contains duplicate query parameter names, Workflow Studio adds the query parameters to the request in the same order as you defined them. Note: When importing an OpenAPI Specification, the system adds all parameters and headers present in the specification to the REST step. Review the final REST step values and remove parameters you do not want to send in the request. For example, if the API accepts content type headers for both JSON and XML, the system adds both headers to the REST step. Remove one of the headers depending on the content type you want to receive in the response. |
| Headers | Headers to send with the request. You can create headers manually, or drag input variables into the parameter fields, and then assign a value. Support REST step requests that contain duplicate request headers. If you create a REST request that contains duplicate request headers, the headers are sent in the same order as you defined them. Note: When importing an OpenAPI Specification, the system adds all parameters and headers present in the specification to the REST step. Review the final REST step values and remove parameters you do not want to send in the request. For example, if the API accepts content type headers for both JSON and XML, the system adds both headers to the REST step. Remove one of the headers depending on the content type you want to receive in the response. |
| Attachment | Attachment record that contains the request. You can look up or create this record in a prior step and define it as an input variable. Create it by using the JSONStreamingBuilder and XMLStreamingBuilder APIs in the Script step. Note: This field is available when you select Binary from the Request Type list. |
| Enable Retry Policy | Option to enable the retry policy. For more information, see [Retry policy](https://www.servicenow.com/docs/access?context=retry-policy&version=australia&pubname=australia-build-workflows&ft:locale=en-US). |
| Override Default Policy for Alias | Option to override the default retry policy. This check box is not applicable when Define Connection Inline is selected from the Connection list. |
| Retry Policy | Default retry policy associated with Connection Alias. If Override Default Policy for Alias is selected, you can override the default retry policy and select another existing retry policy based on your requirement. |
[ ]

{#open-api-step-action-designer__table_z5z_y5t_txb}

## Action error evaluation {#open-api-step-action-designer__section_z3d_r3g_tzb}

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 {#open-api-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 .

## Known limitations {#open-api-step-action-designer__section_vd5_plp_wxb}

Create a OpenAPI step from an OpenAPI Specification with these limitations.  

Request body media types
:   The request body only supports JSON media types.  
    Note:  
    A string type output object is created when the OpenAPI schema has additionalProperties or no properties.

OpenAPI 3.0 components

:   OpenAPI 3.0 adds new components to Swagger 2.0 to describe an API in further detail. OpenAPI support in the OpenAPI step supports some, but not all of these components. The OpenAPI step does not currently support these
    components.

    * Schema Object: additionalProperties properties
    * Discriminator Object
    * Info object: termsOfService, contact, license fields
    * Example Object
    * Link Object
    * Callback Object
    * Security Scheme Object
    * Security Requirements Object
    * Tag Object
    * External Documentation Object
    * Server Object
    * Specification extensions
    * Recursive references
    {#open-api-step-action-designer__ul_gtc_xbp_zhb}

    More information on these components is available in the OpenAPI documentation. See [OpenAPI Specification](https://swagger.io/specification/).

Maximum number of operations supported
:   The number of API operations is limited to 500 by default. However, using the system property glide.rest.openapi.max_operation_limit, you can configure the number of operations from 1 through 1000.