# IFS Assyst

## Overview <a href="#overview" id="overview"></a>

The IFS Assyst Integration enables seamless connectivity between your platform and IFS Assyst (assystREST v2) to synchronize and manage IT service management data. This integration supports incident management, event tracking, and service request workflows through the assystREST API, allowing organizations to streamline ITSM operations through a unified connector framework.

### Prerequisites <a href="#prerequisites" id="prerequisites"></a>

Before initiating the integration, ensure the following requirements are met:&#x20;

* An active IFS Assyst instance accessible over HTTPS.&#x20;
* Valid IFS Assyst username and REST API password (Basic Authentication credentials).&#x20;
* The IFS Assyst domain URL (e.g., as-na-usdemo-app-1.ifsdemoworld.com).&#x20;
* Access to the Spool platform with Admin role privileges.&#x20;
* Network connectivity between the Spool platform and your IFS Assyst instance.&#x20;

### Best practices <a href="#best-practices" id="best-practices"></a>

* **Use the hostname only:** Enter the domain without https\:// prefix or trailing slash.&#x20;
* Validate after setup: Always run Test Connection after saving to confirm credentials and network access.&#x20;
* **Credentials security:** Use a dedicated IFS Assyst service account with read/write access to the required resources. Avoid using personal admin accounts.&#x20;
* **API import:** After initial setup, trigger an API import to populate available endpoints. This only needs to be done once unless the IFS Assyst API surface changes.
* **Network access:** Ensure the platform's egress IP is whitelisted in your IFS Assyst environment if IP restrictions are in place.&#x20;

  &#x20;

## Setup instructions

{% @arcade/embed flowId="R0X3y9kh4B0AmsmkYlqI" url="<https://app.arcade.software/share/R0X3y9kh4B0AmsmkYlqI>" %}

### Initiate integration

{% stepper %}
{% step %}
Log in to the Spool platform using an Admin account.
{% endstep %}

{% step %}
Navigate to Settings → Integrations.
{% endstep %}

{% step %}
Click the "+ Add Integration" button.
{% endstep %}

{% step %}
Search for IFS Assyst and select the integration.
{% endstep %}
{% endstepper %}

### Basic configuration <a href="#step-2-basic-configuration" id="step-2-basic-configuration"></a>

{% stepper %}
{% step %}
In the configuration tab, enter a suitable name for the integration.
{% endstep %}

{% step %}
The connector capability is APITask
{% endstep %}

{% step %}
Click Next to proceed.
{% endstep %}
{% endstepper %}

### Authentication

{% hint style="info" %}
IFS Assyst uses Basic Authentication (username + password encoded as Base64). No OAuth flow or token exchange is required.
{% endhint %}

{% stepper %}
{% step %}
In the Authentication tab, enter the IFS Assyst Domain URL (hostname only, without https\:// prefix).
{% endstep %}

{% step %}
Enter your IFS Assyst Username.
{% endstep %}

{% step %}
Enter your IFS Assyst Password.
{% endstep %}

{% step %}
Click Connect.
{% endstep %}
{% endstepper %}

### Validation & verification

{% stepper %}
{% step %}
Upon successful authentication:

1. The integration will be added successfully.&#x20;
2. A confirmation (success message) will be displayed.
   {% endstep %}

{% step %}
Navigate back to the Integrations tab and verify that the newly added integration appears at the top of the list.
{% endstep %}

{% step %}
Click on the Test Connection icon (next to the delete option):
{% endstep %}

{% step %}
If successful, a confirmation message will appear.
{% endstep %}

{% step %}
This confirms that the integration is configured correctly.
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://kb.theloops.io/agenticstudio/integrations/ifs-assyst.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.