## Introduction

Xurrent (formerly 4me) is an enterprise service management platform. This guide walks you through the steps to gather the necessary information and configure your Xurrent account for the purpose of creating a Xurrent Ticketing integration.

Xurrent uses **Personal Access Tokens** for API authentication.

## Prerequisites

Before you begin, ensure that you have:

- Access to the web interface of Xurrent
- Access to a Xurrent account with permission to create personal access tokens
- Knowledge of which Xurrent environment and region your account runs in


## Required Permissions

A personal access token denies all access by default, so each record type below has to be added to the token's scope.

| Record Type | Access Type | Purpose |
|  --- | --- | --- |
| `requests` | `All` | Retrieve, create, and update the requests that the integration treats as tickets |
| `notes` | `All` | Read and add the notes behind a request's comments and internal notes |
| `note_attachments` | `All` | Upload and download the files attached to a request |
| `projects` | `Read` | List the projects available in your account |
| `service_instances` | `Read` | Look up service instances, so that new tickets reach the right support team |


## Generating API Credentials

1. Log in to Xurrent
2. Select your avatar in the upper-right corner, then select **My Profile**
3. Open the section titled *Personal Access Tokens*
4. Select **Generate new token**
5. Fill in a descriptive name for the token
6. Select **Add record types** and add each of the required record types at the listed access level. The required record types can be found in the section above titled [Required Permissions](#required-permissions)
7. In the section titled *Scope*, select the accounts that the token may access
8. Generate the token and use the copy function to store the value in a safe location. Xurrent does not display it again, and it cannot be recovered
9. You have now created a new Xurrent personal access token. Proceed to the next section titled [Finding Your Account ID](#finding-your-account-id)


For more information on Xurrent personal access tokens, see the [Xurrent Personal Access Tokens](https://learning.xurrent.com/integrations_personal_access_token/) docs page.

## Finding Your Account ID

The account ID is a short string identifier (e.g., `wdc`) that determines which Xurrent account the API operates against.

Navigate to **Settings > Account Overview**. The Account ID is displayed near the top of the page.

## Finding Your Service Instance ID

A **service instance** in Xurrent represents a deployed IT service (e.g., "Network Printing Houston" or "Adobe Support"). When you create a ticket, the service instance determines which support team handles it, which SLAs apply, and how escalation works.

Most Xurrent accounts require a service instance for ticket creation.

1. Navigate to the **Service Instances** page (accessible via the left sidebar under Configuration, or directly at `https://<your-account>.xurrent.com/service_instances`).
2. Click on the desired service instance.
3. Read the numeric ID from the browser URL bar — it appears as `id=<number>` (e.g., `id=281`).


## Configuring the Integration

To configure a new Xurrent integration, provide each of the values as defined below:

| Integration Parameter | Description |
|  --- | --- |
| Account ID | This is the account identifier gathered in [Finding Your Account ID](#finding-your-account-id) above, for example `wdc`. |
| Credential | This is the personal access token generated above. |
| Region | This is the Xurrent environment and region your account runs in. If you are unsure, find the host you use to reach Xurrent in the table below. |
| Service Instance ID | Optional. This is the default service instance used when creating tickets, gathered in [Finding Your Service Instance ID](#finding-your-service-instance-id) above. Most Xurrent accounts require it in order to create a ticket. |


Each region corresponds to one Xurrent API host:

| Region | Host |
|  --- | --- |
| `global` | `api.xurrent.com` |
| `us` | `api.us.xurrent.com` |
| `uk` | `api.uk.xurrent.com` |
| `au` | `api.au.xurrent.com` |
| `ch` | `api.ch.xurrent.com` |
| `demo` | `api.4me-demo.com` |
| `qa` | `api.xurrent.qa` |


`demo` and `qa` are Xurrent's non-production environments.