check-circle-line exclamation-circle-line close-line

<

To add a custom connection, import your Postman collection. The requests in the Postman JSON file are the actions. After you import the collection, the actions become available to use in automation workflows.

Prerequisites

  • Create a collection using the process outlined in Use Postman for Custom Connectors.
  • The service you intend to connect must support REST API and JSON content types.
  • Workspace ONE Intelligence needs access to API endpoints. If services are behind a firewall, use the Unified Access Gateway as reverse proxy.
  • If you use OAuth2 for authentication, have the authorization details so Workspace ONE Intelligence can retrieve, refresh, and access tokens for the service.
    • OAuth2 Token URL
    • Client Secret
    • Client ID
    • Grant Type (Client Credentials or Password)

Procedure

  1. In Workspace ONE Intelligence, go to Integrations > Automation Connectors and select Add Custom Connector.
  2. For Connection Name, enter an identifiable name for the connection.
  3. For Base URL, enter the URL for the service so Workspace ONE Intelligence can authenticate. The URL for the service and the URL for the custom connection must match.
  4. For Auth Type, Select the authentication type to use to access the service. Workspace ONE Intelligence overrides Postman authentication headers in collections with this setting. If your service uses a unique, header-based authentication type, add the header to all your requests in the Postman collection and configure the BaseURL. In this scenario, Workspace ONE Intelligence uses the headers configured in the Postman collection. Examples of header-based authentication types are using an API key or a token.
    • Basic Authentication - Allows Workspace ONE Intelligence access, enter the credentials.
    • OAuth2 Authentication - Enter details so Workspace ONE Intelligence can retrieve, refresh, and access tokens for the service.
    • No Authentication - If you do not want Workspace ONE Intelligence to override authentication headers, select this menu item.
  5. To import your Postman JSON file, use the select from your computer link in the middle of the UI. The UI displays the collection with its requests. These Postman requests are now available as actions for automations.
  6. From the list of imported actions you can test, edit, and delete the action.
    • Delete - If an action you want to delete is used in other automations, the system disables those automations and removes the action. You must edit and reenable those automations to allow them to continue to function. Deletion is not reversible.
    • Edit - You can edit the action names and descriptions. The system gathers names and descriptions from the imported Postman JSON. To edit the action request details, edit the Postman collection and then reimport it into your custom connection.
    • Test - Use the Test menu item to ensure the connection works. The system tests the request configured in the Postman collection.