Creating a REST API Connection

A REST API Connection lets you make REST API calls using the Connector Wizard.

Note: The REST API Connection type is available only if you have installed the Connector Wizard.

To create an REST API Connection:

1. Navigate to Custom > Connections.

2. Click .

3. Under Select a Connection Type, click REST API.

   

4. ClickNext or Basic Properties and create a Queue and Process Server for the Connection. All required settings will be configured automatically.

   

5. Click Next or Security, then click to specify which roles can access the Connection.

6. Click Next or REST Properties. The REST Properties screen displays. Here, you can choose the type of authentication you want to use. For more information, see REST API Authentication Options.

   

   Note: OAuth 2.0 Authorization Code - PKCE is available only if you have Connector Wizard 2.0.0.0 or later installed. This option will automatically generate the code challenge and verifier based on the code challenge method you choose.

7. Click Save & Close.

8. Navigate to Environment > Process Servers and locate the REST API Process Server. If it is not in status Running, right-click it and choose Start, then make sure it reaches status Running.