Get started with Interact

Who this is for

This documentation serves two audiences:

• IT and platform administrators who connect Interact to your organisation's identity providers, directories and business systems, and configure and secure it.
• Developers who customise and extend the intranet with their own styling, code and apps.

Most tasks fall clearly into one camp or the other. The sections below are grouped accordingly, so you can go straight to what you need.

Connect and administer

For IT and platform teams configuring Interact and connecting it to your systems.

• User provisioning — create and keep user profiles up to date, using SCIM, directory connectors, or file upload.
• Authentication & SSO — control how users sign in, with SAML single sign-on and directory authentication.
• Integrations — connect Interact to Microsoft 365, Slack, ServiceNow, Salesforce and other tools your organisation already uses.
• Workplace Search — make content from other systems searchable inside Interact.
• Analytics & data — get intranet data out for reporting and business intelligence tools.
• Platform & security — administer and secure the platform: certificates, HTTP headers, mobile and more.

Customise and build

For developers extending the intranet with code.

• Customise & extend — the Developer Framework: custom CSS, JavaScript, apps and dynamic pages.
• REST API — programmatic access to the core entities in Interact. New to it? Jump into the Quickstart to make your first call in about five minutes.

Note: Developer Framework examples are samples, not officially supported by Interact Technical Support, and should be reviewed and tested by your development team before use.

Placeholders in examples

Code and configuration examples throughout these docs use {{double_brace}} placeholders — for example {{intranet_url}}, {{auth_token}} or {{source_id}}. Replace each placeholder, including the braces, with your own value before running the example.

Next steps

Setting up a new intranet? Start with the essentials:

• User provisioning — get your people and their profiles into Interact.
• Authentication & SSO — let them sign in with your identity provider.

Building on the API? Start with the REST API Quickstart.

New here? The Glossary defines the key terms used across these docs, and Get help and support explains how to reach us.