Use the Postman app to create standard REST APIs for custom connectors. This content offers a general workflow for creating and exporting Postman collections as JSON files.
The free version of the app has the features to create collections with requests and export them for automations.
This topic serves as a general overview of what you must do to create and export a collection. It is meant as a reference. See the Postman Learning Center for the latest instructions on how to configure the Postman product.
Get the Postman app from https://www.getpostman.com.
- Add a collection.
- Add and configure requests in the collection.
- The name and description provided in these requests are used in the workflow actions in Workspace ONE Intelligence. You can change them later within Workspace ONE Intelligence. Here is an example of an entry in a Postman request and how it renders as an action in automations in Workspace ONE Intelligence.
- Consider adding headers as
Content-Type: application/json. If you do not add headers as the content type JSON, the APIs can default to XML and XML does not work with custom connectors.
- Add any custom headers required by your API to all the requests in the Postman collection. Examples of custom headers are unique, header-based authentication types like an API key or a token. Workspace ONE Intelligence retains all headers except for authentication headers. It overrides authentication headers with your configurations for Auth Type in the custom collection. If Workspace ONE Intelligence overrides the authentication header, the system still sends your unique, header-based authentication for use because you added it to other requests.
- Send the request to validate it. Validation generates the response.
- Save the response as an example for documentation. The Open API protocol requires this step.
- Save the request.
- Add more requests as needed.
- Export the collection as Collection v2.1.