> This page is for Assistant Platform.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Lab #3: Connectors & API Playground

> **Info**
>
> ## Overview
>
> * **Learning Objectives:** Connect ServiceNow to Moveworks and validate that the connection works.
> * **Estimated Time:** 30 minutes
> * **Prerequisites:**
>   * [Lab #2: ServiceNow Setup](/ai-assistant/getting-started/labs/moveworks-setup/lab-2-servicenow-setup) complete
>   * Your ServiceNow instance URL and the `machine_admin` integration account's password (saved in Lab #2: ServiceNow Setup)

---

### Key Concepts

Moveworks uses connectors to establish secure links with your enterprise systems. Validating these connections is the first step in any implementation:

* **Connector Instance:** A configuration that stores the authentication credentials (for example, Basic Auth or OAuth) and the base URL for an external system like ServiceNow.
* **API Playground:** A built-in testing environment for running API calls through a connector, to confirm Moveworks has the permissions it needs to fetch data.
* **Response Payload:** The raw JSON returned by the system. Reviewing it shows you the exact field names (for example, `sys_id`, `user_name`) that later mapping steps use.
* **Status Codes:** Standard HTTP indicators (200 for success, 401 for unauthorized) used to diagnose connection or permission issues.

**Relevant Documentation:**

* [Moveworks Help: Creating Connectors](/tool-studio/connectors/system-connectors)
* [Moveworks Help: Using the API Playground](/platform-management/moveworks-setup/api-playground)

---

## 🛠️ 1: Walkthrough

### 1.1: Create Your ServiceNow Connector

1. In Moveworks Setup, navigate to **Connectors > Built-in Connectors**.

2. Click **Create New**.

   ![](/_fern-files/_img/66ecf99e90b5d9cf933fdb326a8f1399cc5edd56e0d709c28935dd90f128d6e3.webp)

3. Use the search bar in the upper right to find the ServiceNow connector, and select it.

   ![](/_fern-files/_img/6feb8a3e959b15ad20d4db2ec370b87c9d458553495f548dd788caac97e0e137.webp)

4. Enter the following values and leave everything else blank:

   | **Field**           | **Value**                                                                                              |
   | ------------------- | ------------------------------------------------------------------------------------------------------ |
   | **Connector Name**  | `snow`                                                                                                 |
   | **Common Base URL** | Your ServiceNow instance name: the `[your-instance]` part of `https://[your-instance].service-now.com` |
   | **Auth Type**       | Basic Auth                                                                                             |
   | **Username**        | `machine_admin`                                                                                        |
   | **Password**        | The `machine_admin` password from Lab #2: ServiceNow Setup                                             |

   > **Error**
   >
   > **The connector name must be `snow`.** Later labs (User Identity, Enterprise Search, Forms, Ticketing) reference this exact value. If you use a different name, substitute it everywhere a lab shows `snow`.

   ![](/_fern-files/_img/874cde5dbc16334cde419dcf57475110fb17ef4bad34000e68cf28058225b653.webp)

   *The screenshot shows `admin` as the username. Enter `machine_admin`.*

5. Click **Save**.

### 1.2: Confirm the Connection in API Playground

1. Navigate to **Connectors > API Playground**.

2. Click **Select Connector** and choose the **snow** connector you created in Section 1.1.

   ![](/_fern-files/_img/8b637e9d9871f4917a6173fde7f1c5255a7b2bb12079a6415655ffb096e20fcd.webp)

3. Click into the **API Collection** search bar on the left and search for `sys_user`.

4. Select the GET request, then click **Test**.

   ![](/_fern-files/_img/d24dd9083deb8a2d563c6e137f1ab8f606b295b3c1be3be4ad780445f2e5757b.webp)

---

## ✅ 2: Verification & Next Steps

**Confirm access:**

* When you click **Test**, confirm you get a `200` response. This shows the ServiceNow instance is connected to Moveworks.

> **Note**
>
> **Your response won't have the same values as the screenshot.** The goal is to confirm you can make a GET call to the user table in your ServiceNow instance.

![](/_fern-files/_img/57dadc5695c07af0051392bb85b7189fc03abb422f923add241a05b0b25068bd.webp)

> **Note**
>
> **Getting a `401`?** Confirm the username is `machine_admin`, the password is current, and the account has the `snc_basic_auth_api_access` role (Lab #2: ServiceNow Setup, Section 1.3).

> **Success**
>
> **Next:** [Lab #4: User Identity & Service Account Setup](/ai-assistant/getting-started/labs/moveworks-setup/lab-4-user-identity-service-account)

---

## 🪞 3: Reflecting on This Configuration

Through this lab, you've learned the following:

* How to connect an external system to Moveworks
* How to validate that connection using API Playground

How this comes up during live implementations:

* After creating a connector, **always validate** that it has the permissions the full integration needs. Confirm the connector lets Moveworks:
  * Query the users in the environment
  * For knowledge: query the content, and the permissions for users and groups
  * For ticketing: query the tables and endpoints Moveworks will support

---

## ⚙️ 4: Configuration Details

Use the table below to fill in the required fields accurately.

| **Field Name**                        | **Action / Value to Enter**                |
| ------------------------------------- | ------------------------------------------ |
| **Connector Name**                    | `snow`                                     |
| **Common Base URL**                   | Your ServiceNow instance name              |
| **Auth Type**                         | Basic Auth                                 |
| **Username / Password**               | `machine_admin` and its password           |
| **API Playground > Select Connector** | `snow`                                     |
| **API Collection**                    | `sys_user` > `GET /api/now/table/sys_user` |