# Integration

## New Integration

Back in the **Unifi Integration Designer** window, after clicking either on the '**+**' **tile** or '**New Integration**', you are given a 'New Integration' modal to complete.

The fields to be configured for the New Integration modal are as follows:

|  #  | Field          | Description                                                                                                 | Value        |
| :-: | -------------- | ----------------------------------------------------------------------------------------------------------- | ------------ |
|  1  | Name           | The name of the integration.                                                                                | \<Your Name> |
|  \* | Service type   | The type of web service this integration is using *(Choices: SOAP/REST)*.                                   | 'REST'       |
|  \* | Message format | Automatically pre-process incoming messages for simpler message scripting. *(Choices: XML, JSON, Advanced)* | 'JSON'       |

{% hint style="info" %}
\*Service type/Message format:  these values are defaulted.
{% endhint %}

*Your 'New Integration' modal should look like this:*

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdSFm2AihNbBJUn6Qrj%2F-MdSnb_qmO9znBfr-hsf%2FBAIG%20-%20Integration%201.png?alt=media\&token=61598604-eb0b-449b-a8ba-56e3c8759934)

2\) Click **Create**.

You will be redirected to the Details page of the newly created Integration.

## Icons

{% hint style="info" %}
Before continuing we would like to draw your attention to some of the relevant icons that are now visible down the left hand navigation strip.
{% endhint %}

*The icons are:*

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdSFm2AihNbBJUn6Qrj%2F-MdSpG0HYGBdCR0BbGjE%2FBAIG%20-%20Integration%202.png?alt=media\&token=fb375554-a5b5-4ce7-9613-8915fc4fa414)

a) ***'Integration' icon*****:** Opens the current integration's Details page.

b) ***'Messages' icon*****:** Opens the current integration's Messages page.

c) ***'Fields' icon*****:** Opens the current integration's Fields page.

d) ***'Field Maps' icon*****:** Opens the current integration's Field Maps page.

e) ***'Documentation' icon*****:** Opens the automatically generated documentation for the current integration. *(Another awesome feature in **Unifi**.)*

f) ***'Connections' icon*****:** Opens the current integration's Connections page.

## Details

*The Details page of your Integration should look like this:*

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdSFm2AihNbBJUn6Qrj%2F-MdSu_TkTbD05rienWRX%2FBAIG%20-%20Integration%203.png?alt=media\&token=14632141-777e-4224-af56-e4b6505ebdc8)

3\) Navigate to **Integration > Message Identification**.

## Message Identification Fields

{% hint style="info" %}
Unifi needs to identify the name of the inbound message in order to know how to process the inbound data.
{% endhint %}

4\) Update the code in the 'Identify message script' field so that it looks like this:

```javascript
function identify(payload) {

  return (payload.message.name || '') + '';

}
```

*The Message Identification form should look like this:*

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdSFm2AihNbBJUn6Qrj%2F-MdSvk6kG2p9rqsgSNAN%2FBAIG%20-%20Integration%204.png?alt=media\&token=2d9a0077-a20a-4c89-a12d-10b5c96cde85)

5\) Navigate to **Settings > Feedback**.

## Feedback Settings Fields

The Feedback fields to be configured for the Integration record are as follows:

|  #  | Field              | Description                                                                                                              | Value   |
| :-: | ------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------- |
|  6  | Enable UI messages | Allow information and error messages to be shown to the user as UI Notifications. Only applies to certain notifications. | \<true> |

*The Feedback Settings form should look like this:*

![](https://2404534899-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQBk35gIi557UHt7QlJ%2F-MdSFm2AihNbBJUn6Qrj%2F-MdSwnuZz9Y7r5Y6PqXR%2FBAIG%20-%20Integration%205.png?alt=media\&token=3a42d99b-12f1-4cee-ae2e-27ec3ef2a96e)

{% hint style="info" %}
All of the remaining 'Settings' values are to be left as-is:

* Attachments Settings
* Bond Settings

All of the 'Error handling' values are to be left as-is:

* General
* Timeouts
* Retry
  {% endhint %}

7\) Click **Save**.

8\) Click the **'Connections' icon** to move on and configure the **Connection**.