Skip to main content

Overview

What Integrations Does​

Integrations connects UNICONNECT AI to the other systems an organization already runs, in both directions. It lets an outside system call UNICONNECT AI, it lets UNICONNECT AI call an outside system, and it lets an outside system push events to UNICONNECT AI as they happen. None of this needs a custom backend for each system.

All of it sits under Configuration → Integrations, which has three areas: Service Accounts, Webhook and API Integrations. LDAP Authentication, a plugin under Configuration → System → Plugins, is part of the same guide.

Service Accounts screen with the Integrations menu expanded in the Configuration sidebar, showing Service Accounts, Webhook and API Integrations

Figure 1. The Integrations menu in the Configuration sidebar, opened on the Service Accounts screen.

The Three Step Flow​

Bringing an outside system into the CRM follows one pattern, and every page in this guide builds on it.

  1. Collection. A Collection represents one outside system. It holds the base address, default headers and parameters, and the way to authenticate. See Collections.
  2. API. An API is one endpoint inside a collection, for example a customer lookup. See Creating an API.
  3. Module or Workflow. The API is then used where it is needed: as the source of an external CRM module, or as an action inside a workflow. See Creating an External Module and Using APIs in Workflows.

The Integrations Areas​

AreaDirectionWhat it is for
Service AccountsOutside system calls UNICONNECT AICredentials for REST clients, MCP tools and BI or database tools. See Service Account Configuration.
API IntegrationsUNICONNECT AI calls an outside systemCollections and APIs that feed CRM modules and workflows. See Collections.
WebhookOutside system pushes events inAn address an outside system can post to, with a schema that describes the payload. See Webhooks.
LDAP AuthenticationDirectory accounts sign inA plugin that lets Active Directory or OpenLDAP users sign in to UNICONNECT AI. See LDAP Authentication.
API DocumentationReferenceA Swagger page that lists the REST endpoints for CRM modules. See API Documentation.

The Example Used in This Guide​

The guide follows one example from start to finish. AUS Bank's collections team keeps customer identity checks in an outside system called PolicyHub KYC. The team wants a customer's record from PolicyHub to appear inside the CRM, without anyone copying data across. The collection is named PolicyHub KYC, its APIs are List Customers and Get Customer, and the CRM module that reads them is Policy Customers. Amara Whitfield is the sample customer.

Planning Notes​

info

Integrations is part of the license edition. The License Details screen under Monitoring shows how many service accounts the license allows, and the Integrations menu appears in Configuration only when the feature is included.

warning

Service accounts and collections hold credentials. Give the Integrations permissions only to the administrators who manage connections. See Integrations Permissions.