---
title: "REST Service Integration Overview"
slug: "rest-service-integration-overview"
description: "This document looks at REST Service Integration. The REST Service holds the configuration data that's shared between all calls to a service, and acts as a folder that holds any number of REST Methods.  REST Methods define HTTP Calls to a URL defined by the service. This document shows how to create and understand REST Services."
updated: 2025-06-06T14:57:41Z
published: 2025-06-06T14:57:41Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.decisions.com/llms.txt
> Use this file to discover all available pages before exploring further.

# REST Service Integration Overview

## Overview

The REST Service integration holds configuration data that is shared between REST Service methods in the REST Service such as the base URL, authentication, and any custom headers. Each REST method is an HTTP call that can be made to obtain or send data.

---

## Creating a REST Service

1. Navigate to **System > Integrations > External Services**. Click ADD REST SERVICE.**![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-08-06_10h09_36.png)**
2. Enter the name and URL for the Service.  
![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-08-06_10h11_29.png)The Show Advanced Options settings will allow the user to define additional HTTP Headers. Any headers set here will be applied to all REST Methods for this service unless overridden in the REST Method.
3. After entering the URL, the **Ping Result** field will show the result of trying to reach that URL. Configure any necessary variables using braces to define them within the URL.  These variables will appear as Flow step inputs. For example, a URL with a variable would be https://example.com/api/fetch/{requestId}/accounts.
4. Configure the Authentication for the Service. Then, click SAVE INTEGRATION.

---

### **Variables**

Variables can be defined as part of the URL in a REST Service or REST Method, as well as in the request body. These variables will appear as inputs to the REST Method Flow step, and those input values will automatically be inserted in the appropriate locations when the step runs.

To include a variable in a URL or request body, put the variable name inside curly braces, with no spaces (i.e, {myNewInput})

Variable definitions won't interfere with JSON in the request body because the variable name must appear with no spaces or other special characters. For example, this request body defines 2 variables (company name and count) and includes them inside the JSON: { "name":"{companyName}", "count": {count} }

Variables that are included in the request body or as part of the URL will be URL encoded. However, values added to the REST method's **URL path relative to the base** section will not be encoded. For more information on creating a REST method, please visit [Creating a REST Method](https://documentation.decisions.com/v9/docs/creating-a-rest-method).

## Authentication Settings

After setting the necessary variables. Set the Authentication method for accessing the Service. The Authentication settings on the REST Service can also be overridden on each REST Method.

### Basic Authentication

| Setting Name | Description |
| --- | --- |
| **Pre-Authenticate Request** | Includes credentials in the request header. |
| **Use Static Credentials** | Choose user and password here, rather than in the Flow. |

The user account that this will use is the account running Decisions Server and **not** the user account executing the step. This is the account Properties dialog window under **Log on.**

![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/image-1648829259587.png)

### Windows Auth

Uses the Windows environment for authentication.

### Use OAuth

From the Authentication settings, toggling **Use OAuth Settings** triggers the appearance of the OAuth panel below.

| Setting Name | Description |
| --- | --- |
| Use Custom Tag in Auth Header (OAuth is Default) | Allows the user to input a custom OAuth header tag |
| Use Static OAuth Token | Provides the user with a dropdown menu that allows the user to select a pre-made OAuth Token. Without this enabled, the Token will be available as the Input. |
| Direct OAuth1 Signed Request | Use OAuth1 to send a direct request signed with a private certificate. Provides the**Consumer Key, Initial Token Data, PFX Filename,**and**PFX Password** Input boxes. Consumer Key and PFX Filename are required for this option. |

It is advised NOT to use a Static OAuth Token; this is because the REST Service is not deployable by the OAuth Token. If a Token is set as Static, the user will have to update the REST Service to point to Tokens on a new system, when deploying to a new Server.

### **Ignore Server Certificate Errors**

Ignores certificate errors produced by the server when authenticating

### **Enable Mutual Authentication**

Enables users to upload SSL credentials such as a P12/PFC Certificate and the P12/PFK Password. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/image-1648828456389.png)

---

## Defining Headers in REST Service Using Advanced Options

To help with such errors as Proxy Authentication Errors, provide additional information, or if additional Authentication that cannot be fulfilled by the Authentication settings is required, users may add **Custom****Headers**to their REST Service****to pass in that information.

1. Under**System > Integrations > External Services**
2. Right-click the desired REST Service and select **Edit Service**.
3. From the **Edit Service** window, under SERVICE DEFINITION, check the **Show****Advanced****Options**box.
4. Under **SERVICE DEFINITION [ADVANCED] > Additional HTTP Headers**, click ADD.  
![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-08-06_10h12_41.png)
5. From the Add Additional HTTP Headers window, provide the **Header****Key**and the **Flow Step Variable Name**, then click OK.Note on Additional Header SettingsThe Header Key represents the name of the Header being passed into the call. The Flow Step Variable Name represents the Data Name that will be used as the step's input in the Flow Designer.

![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-08-06_10h15_19.png)

Further on Additional Header SettingsTo find any Headers that may be required for the Integration via Flow, utilize API testing software such as Postman, and create a call using the Integration URL for the Service. Upon pasting in the URL, the Headers tab will populate with any Headers related to the Service. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2021-05-13_13h35_57.png)
6. After all desired edits have been made, click SAVE INTEGRATION. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-08-06_10h15_55.png)

---

For further information on Integrations, visit the [Decisions Forum](https://community.decisions.com/categories/Integrations).