Connectors

Connectors allow workflows to interact with various external services and applications by utilizing APIs. This interaction enables the automation of tasks and processes without the need for human intervention.

Connector Types

  • CXone Mpower Applications: Integrate with various CXone Mpower applications.

  • Third-Party Applications: Connect to external third-party applications.

  • Custom Connector: Create custom connectors that follow OpenAPI support requirements.

Set Up a Custom Connector

Setting up a custom connector allows seamless integration with external REST services. By following a few steps, you can create, configure, and test a connector using OpenAPI standards, ensuring secure and efficient communication with external APIs.

To set up a Custom Connector:

  1. On the My Workflow Insights dashboard, click the Connectors icon to access the connectors panel.

  2. In the left panel, select the option to create a new connector.

  3. To select OpenAPI, select OpenAPI from the drop-down menu.

  4. Create and name the connector service request.

  5. To configure the connection, go to the Connectors design page, click the OpenAPI field and select a connection.

  6. Enter the URL to the REST service for the OpenAPI connection.

  7. Select the API from the list of available APIs as defined in the OpenAPI documentation.

  8. To set HTTP Methods, choose the appropriate HTTP method (e.g., GET, POST) from the drop-down list. The Pathing, Parameters, Headers, and Body sections will be automatically populated based on the API definition.

  9. To define parameters and body, modify the values in the Parameters and Body sections if needed. Ensure that the JSON strings in the body of the request include the proper escape notation for variables.

  10. To enable security configuration, enter the credentials required to access the external REST services. Make sure that the security settings comply with the OpenAPI 2.0 or 3.0 standards.

  11. Test the connector to ensure it correctly invokes the REST service. Review the JSON response body to verify the output.