# Access Endpoint Central Spoke Actions in ServiceNow Workflow Studio

## How to Access Endpoint Central Spoke Actions in Workflow Studio?

This guide provides ServiceNow administrators with step-by-step instructions for accessing and using Endpoint Central spoke actions within Workflow Studio. Learn how to automate endpoint operations including software deployment, device status monitoring, and encryption key retrieval through six powerful integration actions. Each action includes detailed input requirements, output variables, and troubleshooting guidance to help you build reliable, automated workflows.

## Contents

- [Prerequisites](#prerequisites)
- [Steps to Access Endpoint Central Spoke Actions](#steps)
- [Endpoint Central Spoke Actions](#endpoint-central-spoke-actions)
  - [1. Look up Device Live Status](#1-look-up-device-live-status)
  - [2. Install Software](#2-install-software)
  - [3. Uninstall Software](#3-uninstall-software)
  - [4. Look up Deployment Status](#4-look-up-deployment-status)
  - [5. Look up Windows Encryption Key](#5-look-up-windows-encryption-key)
  - [6. Look up Mac FileVault Key](#6-look-up-mac-filevault-key)

## Prerequisites

Before using Endpoint Central Spoke actions in Workflow Studio, ensure the following:

- The Endpoint Central App is installed and activated in ServiceNow. Refer to the [document](https://www.manageengine.com/products/desktop-central/servicenow-integration-using-dc-plug-in-app.html) to install Endpoint Central App from ServiceNow store.
- Your ServiceNow account has the below mentioned roles to execute endpoint actions.
  - action_designer
  - flow_designer
  - flow_operator
  - x_manen_medc.DCIntegrationUser

## Steps to Access Endpoint Central Spoke Actions

Follow these simple steps to view and use Endpoint Central Spoke actions in your ServiceNow Workflow Studio:

1. Log in to your ServiceNow instance
2. Navigate to: **All** → **Process Automation** → **Workflow Studio**
3. Switch to the **Actions** tab
4. Create a filter on the **Application** column:
   - Condition: **contains**
   - Value: **Endpoint Central**
5. The list will display all available Endpoint Central Spoke actions

Once visible, these actions can be dragged directly into your flows and sub-flows.

![login to servicenow instance](https://www.manageengine.com/products/desktop-central/images/spoke1.png)
![navigate to workflow studio](https://www.manageengine.com/products/desktop-central/images/spoke2.png)
![switch to actions](https://www.manageengine.com/products/desktop-central/images/spoke3.png)
![create a filter on the application column](https://www.manageengine.com/products/desktop-central/images/spoke4.png)
![list will display endpoint central actions](https://www.manageengine.com/products/desktop-central/images/spoke5.png)

## Endpoint Central Spoke Actions

### 1. Look up Device Live Status

This action checks whether a target device is currently online and reachable before executing automation tasks.

**Note:** All input fields are mandatory.

#### Inputs

| Field | Type | Description |
|---|---|---|
| Computer Name | String | Computer name as it appears in Endpoint Central Inventory |
| Domain Name | String | Domain name as it appears in Endpoint Central Inventory |

#### Outputs

| Output Variable | Type | Description | Possible Values |
|---|---|---|---|
| Code | String | Operation status code | **0** - Success<br>**1** - Invalid Inputs<br>**2** - API Error<br>**400** - API Call Failed |
| Message | String | Brief explanation of the result | **Code 0:** Success<br>**Code 1:** No device found for the provided inputs.<br>**Code 2:** Endpoint Central app internal error. Contact Endpoint Central support and share the application logs.<br>**Code 400:** API call failed with status code *<code_value>*. Contact Endpoint Central support and share the application logs. |
| Live Status | String | Current status of the machine | Online, Offline, Unknown, or Error |
| Is Online | Boolean | Simple true/false status | **true** - Device is online<br>**false** - Device live status is offline, unknown, or error |

### 2. Install Software

This action automatically installs selected software packages on target endpoints.

**Note:** All input fields are mandatory.

#### Inputs

| Field | Type | Description |
|---|---|---|
| Computer Name | String | Computer name as it appears in Endpoint Central Inventory |
| Domain Name | String | Domain name as it appears in Endpoint Central Inventory |
| Endpoint Central Software Package | List of Records | Software packages from the table `x_manen_medc_dcsoftwarepackages`<br>*These records sync automatically via the scheduled job 'Sync Software details'* |

**What is 'Sync Software details' scheduled job?**

Using the Endpoint Central app, ServiceNow automatically synchronizes software package details from Endpoint Central on a daily schedule. Administrators can adjust the synchronization frequency based on organizational needs; however, a minimum interval of 3 hours between sync cycles is recommended.

#### Outputs

| Output Variable | Type | Description | Possible Values |
|---|---|---|---|
| Code | String | Operation status code | **0** - Success<br>**1** - Invalid Inputs<br>**2** - API Error<br>**400** - API Call Failed |
| Message | String | Brief explanation of the result | **Code 0:** Success<br>**Code 1** (one of the following):<br>- No device found for the provided inputs.<br>- The selected package is not available.<br>**Code 2:** Endpoint Central app internal error. Contact Endpoint Central support and share the application logs.<br>**Code 400:** API call failed with status code *<code_value>*. Contact Endpoint Central support and share the application logs. |
| Collection ID | String | Unique ID created by Endpoint Central for the deployment | Example: 76297000000703059 |

### 3. Uninstall Software

This action removes selected software packages from target endpoints.

**Note:** All input fields are mandatory.

#### Inputs

| Field | Type | Description |
|---|---|---|
| Computer Name | String | Computer name as it appears in Endpoint Central Inventory |
| Domain Name | String | Domain name as it appears in Endpoint Central Inventory |
| Endpoint Central Package | List of Records | Software packages from the table `x_manen_medc_dcsoftwarepackages`<br>*These records sync automatically via the scheduled job 'Sync Software details'* |

#### Outputs

| Output Variable | Type | Description | Possible Values |
|---|---|---|---|
| Code | String | Operation status code | **0** - Success<br>**1** - Input Error<br>**2** - API Error<br>**400** - API Call Failed |
| Message | String | Brief explanation of the result | **Code 0:** Success<br>**Code 1** (one of the following):<br>- No device found for the provided inputs.<br>- The selected package is not available.<br>**Code 2:** Endpoint Central app internal error. Contact Endpoint Central support and share the application logs.<br>**Code 400:** API call failed with status code *<code_value>*. Contact Endpoint Central support and share the application logs. |
| Collection ID | String | Unique ID created by Endpoint Central for the deployment | Example: 76297000000703059 |

### 4. Look up Deployment Status

This action checks the deployment status of software installation or uninstallation tasks.

**Note:** All input fields are mandatory.

#### Inputs

| Field | Type | Description |
|---|---|---|
| Collection ID | String | Collection ID returned from Install Software or Uninstall Software actions |

#### Outputs

| Output Variable | Type | Description | Possible Values |
|---|---|---|---|
| Code | String | Operation status code | **0** - "Success" or "In Progress" or "Failed" or "Yet to Apply"<br>(see the table below for more details on each status)<br>**1** - Invalid Input<br>**2** - API Error<br>**400** - API Call Failed |
| Message | String | Brief explanation of the result | **Code 0:** Deployment completed successfully.<br>**Code 1:** No deployment found for the specified Collection ID.<br>**Code 2:** Endpoint Central app internal error. Contact Endpoint Central support and share the application logs.<br>**Code 400:** API call failed with status code *<code_value>*. Contact Endpoint Central support and share the application logs. |
| Remarks | String | Additional details about the configuration status | This field may be empty or contain messages such as ‘The parameter is incorrect’. |
| URL | String | Direct link to the configuration in Endpoint Central console | Only available when Code is 0<br>Example: https://endpointcentral.manageengine.in/webclient#/uems/configuration/109832 |

#### Configuration Status Values

| Status | Description |
|---|---|
| In Progress | The software is currently being installed or uninstalled |
| Failed | The installation or uninstallation process failed |
| Yet to Apply | The configuration is ready and will execute during the next device refresh cycle |

### 5. Look up Windows Encryption Key

This action retrieves the BitLocker recovery key for Windows devices.

**Note:** All input fields are mandatory.

#### Prerequisites

- The ServiceNow system property `x_manen_medc.bitlocker` must be enabled by your administrator.
- 'Look up WIndows Encryption Key' spoke is currently limited to Windows machines only.

#### Inputs

| Field | Type | Description |
|---|---|---|
| Computer Name | String | Computer name as it appears in Endpoint Central Inventory |
| Domain Name | String | Domain name as it appears in Endpoint Central Inventory |
| Recovery Key Identifier | String | The key identifier displayed on the device’s BitLocker recovery screen (BSOD). This value must be provided by the end user.<br>It can also be obtained in Endpoint Central by navigating to BitLocker Management > Managed Computers and clicking the device name. |

#### Outputs

| Output Variable | Type | Description | Possible Values |
|---|---|---|---|
| Code | String | Operation status code | **0** - Success<br>**1** - Input Error<br>**2** - API Error<br>**400** - API Call Failed |
| Message | String | Brief explanation of the result | **Code 0:** Success<br>**Code 1** (one of the following):<br>- No device found for the provided inputs.<br>- This action is supported only for Windows devices.<br>- No encryption key available for this device.<br>- ServiceNow system property `x_manen_medc.bitlocker` must be enabled by an administrator.<br>**Code 2:** Endpoint Central app internal error. Contact Endpoint Central support and share the application logs.<br>**Code 400:** API call failed with status code *<code_value>*. Contact Endpoint Central support and share the application logs. |
| Encryption Keys | Array of Objects | Contains encryption keys for each encrypted drive | JSON object with array (may be empty or contain one or more keys) |

#### Sample JSON Object

```plaintext
{
 "Encryption Keys": [
 {
 "drive_letter": "C",
 "recover_key": "xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx" 
 } ] }
```

### 6. Look up Mac FileVault Key

This action retrieves the FileVault recovery key for macOS devices managed through MDM.

**Note:** All input fields are mandatory.

#### Prerequisites

The ServiceNow system property `x_manen_medc.bitlocker` must be enabled by your administrator.

#### Inputs

| Field | Type | Description |
|---|---|---|
| Serial Number | String | Serial number of the macOS device managed by MDM |

#### Outputs

| Output Variable | Type | Description | Possible Values |
|---|---|---|---|
| Code | String | Operation status code | **0** - Success<br>**1** - Input Error<br>**2** - API Error<br>**400** - API Call Failed |
| Message | String | Brief explanation of the result | **Code 0:** Success<br>**Code 1:** ServiceNow system property *x_manen_medc.bitlocker* must be enabled by an administrator.<br>**Code 2:** Endpoint Central app internal error. Contact Endpoint Central support and share the application logs.<br>**Code 400:** API call failed with status code *<code_value>*. Contact Endpoint Central support and share the application logs. |
| RecoveryKey | String | The actual FileVault recovery key | Format: A1B2-C3D4-E5F6-G7H8-I9J0-K1L2 |

## Related Documents

- [Endpoint Central Spoke in ServiceNow Workflow Studio](https://www.manageengine.com/products/desktop-central/help/servicenow-endpoint-central-spoke-guide.html)