Add your own connections and actions to automation workflows with your existing enterprise systems and third-party services. Custom connectors use REST APIs for communication and the API development tool Postman to create standard requests.
Automate Your Internal Services with Custom Connectors
If the service supports REST APIs and JSON content types, you can use it in your automations with custom connectors.
Postman to Create Standard REST APIs
Workspace ONE Intelligence uses Postman to standardize the REST APIs the system uses to connect and act with your internal and third-party services. It creates actions using a familiar REST template interface that allows for reuse of the saved actions. The free version of Postman has the features required to create collections for custom connectors.
Steps to Use Custom Connectors
- Create a collection with requests in Postman and export it.
- Add a custom connection in the Workspace ONE Intelligence console and import the requests. These requests are now available as actions you can use in automations.
- Configure an automation workflow with imported actions to automate a task using your custom connection in Workspace ONE Intelligence.
Actions for Custom Connectors
You can edit, delete, and test custom connectors in Workspace ONE Intelligence. You can use actions in multiple connectors so consider the consequences of editing or deleting before you act.
- Delete - To delete an entire connection and all its actions, you must deauthorize it first. After deauthorization, any automation using an action associated with this connection is disabled. After the system deletes the connection, it removes all associated actions from other automations. You must edit and reenable the disabled automations to run them again. This action is not reversible.
- Edit - You can edit the connection name, description, and authentication types at any time. To edit the action request details, edit the Postman collection and then reimport it into your custom connection. Note: If you edit authentication types and enter the credentials incorrectly, actions can fail to run. Edit with caution.
- Test - Test custom connectors in Workspace ONE Intelligence to make sure Workspace ONE Intelligence and your service can communicate.
Register a Custom Connector
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.
- 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)
- In Workspace ONE Intelligence, go to Integrations > Automation Connectors and select Add Custom Connector.
- For Connection Name, enter an identifiable name for the connection.
- 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.
- 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.
- 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.
- 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.
Use Postman for Custom Connectors
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.