API Configuration

Prerequisites

In order to follow this guide, you need to enable the Next-gen HTTP Editor first. You can do so by going to Creator Studio > Experimental Features

Then click Enable Next-gen HTTP Editor > Submit

Step 1: Import cURL Request

You can import your entire HTTP Request to shortcut the entire Connector + HTTP Request set up.

1. Click IMPORT CURL

2. Paste your cURL command into the text box.

3. Double check everything is imported the way you expected. Follow on to Step 2 if you need to create a new connector or use an existing one.

Step 2: Set up Connector

Next, you may need to create a new Connector from scratch or use an existing one.

Connectors are used to securely store authentication information + base URL for the HTTP Request which can be reused for future requests. Previously created connectors can be used across new Paths & Queries use cases.

Option 1: Select Existing Connector

1. Click Import Connector

2. Search for your existing connector & then click APPLY

Option 2: Create New Connector

See our guide on Connector Configuration in order to set a new connector up.

Step 3: Set up HTTP Request

Step 3.1: Set up Base Request Info

If you're manually configuring your API, you can do so by editing:

1. Method - We support GET, POST, PUT, DELETE, PATCH methods.
2. Endpoint URL - This is the rest of the URL Path starting from the end of the Base URL. It must start with a / .
   • Note: The Connector's Base URL and the inputted Endpoint URL are combined to create the full Request URL.
3. Headers - ALL Request Headers must be added to this table.
4. Query parameters - ALL Query Params must be added to this table. They cannot be saved in the Endpoint URL .
5. Body - ALL Body content must be added to this text box.
   • Note: If you want to use Content-Type: x-www-form-urlencoded , you have to convert the data to the following format: key=value&key2=value2

Step 3.2: Use Variables in your Request

What Variables are available to me?

In Paths Workspace, you can use all of the Questions you have configured upstream of this HTTP Request + any User Attributes you have configured as variables

All of the variables that come from Paths Questions will be auto-populated in the Input Variables tab as a quick reference.

In Queries Workspace, you can use the query keyword + any User Attributes you have configured as variables.

All of the variables that come from the query keyword will be auto-populated in the Input Variables tab as a quick reference.

Queries pre-populated Input Variables

Paths pre-populated Input Variables from previous Paths Questions

How do I reference Variables in my request?

You can use variables anywhere in the Headers, Params, Body, or Endpoint URL. They can also be used in JWT Connector Claims. You insert variables by using {{VARIABLE_NAME}}. You can check variable names by looking at the Input Variables tab and our User Attributes Reference

If you use a variable in the request and want to Test your API, then you must add an example value to the variable in the Input Variables tab.

Using User Attributes in your API Request

Moveworks provides User Attributes that can be referenced in order to provide information about the current user to an API request. This includes data like user email address, user first & last name, user role & department, and any custom attribute.

• See our User Attribute Reference Guide to see what User Attributes are available to you and how to register more.

In order to use a User Attribute in an API request, you must use the following syntax:

"{{user.email_addr}}"

Example:

Step 4. Test & Save your API!

1. Click TEST in order to kick off a Request with the example data you inputted in the Input Variables tab.

2. Get your API working and then save your connector for future use cases!

Moveworks IP Address Whitelisting

See our IP Address Whitelisting Reference here