Add a REST Connector

Create a REST connector whenever you want to call an external REST service to retrieve, create, update, or delete data in the application.

  1. From a selected process application, click Add in the upper right corner of the page.
  2. In the Add component pane, expand Connectors and choose REST API.
  3. In the Add component pane, enter the following information:
    1. Title: Enter a descriptive name for the connector.
    2. Identifier Name: Automatically populated to uniquely identify the connector. This value can't be changed later.
    3. Base URL: Enter the base endpoint you want the connector to access in REST calls. By default, Process Automation appends .com to the connector’s name and displays that as the default URL.
  4. Click Create.
    The REST connector is displayed on the Connectors page as well as on the process application's main page. You can identify it as a REST connector by the REST icon REST Connector icon.
  5. Open the new connector.
    Click the Open Now link in the creation message that briefly appears or select the new connector from the connector list.
    The REST connector editor opens.
  6. If you want to edit the properties of the connector:
    1. Click Properties Properties from the side menu.
    2. On the Properties pane, you can edit the following:
      • Name
      • Description
      • Base URL
    3. Close the Properties pane to save the changes.