Skip to main content

Ziik: Integration Setup

This guide walks you through how to integrate your Learningbank platform with Ziik, including user synchronization, automatic login, and Ziik chat notifications.

Written by Frederik Kjærgaard

Set up your Ziik integration with Learningbank. With Ziik, you can use user synchronization, automatic login, and Ziik notifications from your platform.

When setting up Learningbank together with Ziik, there are two setup options:

  • A delegated user integration and in-app setup with automatic login

  • An in-app & redirect from app setup with automatic login

Learningbank also offers a communication integration for Ziik chat notifications. This is setup in the Learningbank Integration Hub.

📣IMPORTANT:

  • The integrations offered by Ziik are delegated. This means that Ziik owns the integrations. If you experience missing or incorrect data or login issues, please reach out to Ziik first.

  • Only administrators in Ziik can configure the Learningbank integrations Ziik offer.


Delegated User Integration

When you enable the delegated user integration in Ziik, Ziik will also create the in-app automatic login setup.

You do not have to use the in-app setup. The Learningbank app and website can still be used if preferred. However, this requires users to create their own passwords.


Configure Integration in Ziik

First, you need to obtain the username, password, and token from Learningbank by creating a new set of API keys on your Learningbank platform.

Quick tip💡 Want to learn how to create API keys? Check out this article: Integration: Create an API Key (Credentials) for your platform | Learningbank Help Center

Next, assign a default job profile in Learningbank. The default job profile is used if no job profile exists in Learningbank that exactly matches the name of the user's Ziik role.

Now you are ready to create the integration in Ziik! 🚀

  1. Go to the integration page in the Ziik admin panel.

  2. Click create integration.

  3. Select Learningbank Sync & Login.

  4. Fill in the API credentials you created in Learningbank.

  5. Choose your integration settings.

Quick tip💡


The name you write in the 'Name field' is what users will see in Ziik. Therefore, you should consider what you would like them to see before creating the integration.


It could e.g. be that it should be the same name as your Learningbank platform, so it supports the branding and presence of the platform.

Final step is now, that you synchronize all units, roles, and users to Learningbank. 🔄️


How It Works

The delegated user integration with Ziik imports users, departments, job profiles, and permissions to the Learningbank platform.

Department Synchronization

Departments in Learningbank are based on units in Ziik.

When the integration synchronizes, this is what happens:

  • The top unit in Ziik is connected to the top department in Learningbank.

    • The name of the top department in Learningbank will not be changed.

  • Subunits in Ziik are mirrored 1:1 as departments in Learningbank.

    • This means that the unit hierarchy from Ziik is recreated in Learningbank.

  • If a unit is updated, deleted, or moved in Ziik, the same change will be reflected in Learningbank.

Good to know💭 When Unique Units is enabled in Ziik, the Ziik unit ID is added to the department name. This makes it possible to have multiple departments with the same name on the same level in Learningbank.

User Department Assignment

  • Users are assigned to departments based on their unit memberships in Ziik.

  • If a user has multiple unit memberships in Ziik, all units will be synchronized to Learningbank.

Permission Synchronization

  • Permissions in Learningbank correspond to roles in Ziik. These permissions will be created automatically.

  • If a role is updated or deleted in Ziik, this will also be reflected in Learningbank.

User Permission Assignment

  • Roles on the user's first unit membership in Ziik will be matched with permission types in Learningbank and assigned to the user.

Good to know💭 Any permission types in Learningbank that are not created by Ziik, but are assigned to the user in Learningbank, will remain on the user. Ziik will only add or remove permission types that come from Ziik.

Job Profile Synchronization

  • Job profiles are based on roles in Ziik, but they are not created automatically.

  • They need to be created manually in Learningbank with a 1:1 name match to the role in Ziik.

📣IMPORTANT: If you want users to receive a specific job profile from Ziik, make sure the job profile already exists in Learningbank with the exact same name as the Ziik role.

User Job Profile Assignment

  • If there is a Learningbank job profile that matches the user's role in Ziik exactly, this job profile will be applied to the user.

  • If there is no Learningbank job profile that matches the user's role, the default job profile will be assigned by Learningbank when the user is created. It can be changed manually in Learningbank user administration afterwards.

Users

Users in Ziik are created as users in Learningbank with the following attributes:

  • First name

  • Last name

  • Email address

  • Active/inactive status

  • Language

  • Department(s)

  • Job profile (if exists in Learningbank beforehand)

  • Permission(s)

Updating any of these fields, except language, will also update the fields in Learningbank.

This also applies to the user status. If a user is deactivated or deleted in Ziik, they will also be deactivated in Learningbank.

Quick tip💡

Ziik does not delete users in Learningbank. Users are only deactivated. Remember to set up User Automation on the User Management page to delete or anonymize deactivated users after a period of deactivation when needed.


In-App with Automatic Login

All users who have been synchronized from Ziik to Learningbank with the delegated user integration will find a shortcut to their Learningbank environment in the Ziik menu.

On web, it is shown in the left-hand menu.

On the app, it is created as a tile on the home screen.



In-App & Redirect from App with Automatic Login

Ziik offers an integration that automatically logs users in to Learningbank directly from Ziik.

  • When users access Learningbank from the Ziik app, Learningbank opens in-app.

  • When users access Learningbank from the Ziik website, they are redirected to their Learningbank platform.

When the Learningbank Login integration is configured, all Ziik users with a matching email in the integrated Learningbank system can access their Learningbank environment directly from Ziik.

This integration does not import users. ❌


Configure Integration in Ziik

First, obtain the username, password, and token from Learningbank by creating a new set of API keys.

Quick tip💡

Want to learn how to create API keys? Check out this article: Integration: Create an API Key (Credentials) for your platform | Learningbank Help Center


When these are obtained, you are ready to set up the integration on Ziik! 🚀

  1. Go to the integrations page

  2. Go to the integrations page in the Ziik admin panel.

  3. Click create integration to get started.

  4. Select Learningbank Login.

Fill in the API credentials created, when creating the Learningbank integration in Ziik.

The integration is now created and ready to use ✅

Quick tip💡

The name you write in the 'Name field' is what users will see in Ziik. Therefore, you should consider what you would like them to see before creating the integration.

It could e.g. be that it should be the same name as your Learningbank platform, so it supports the branding and presence of the platform.



How It Works

All Ziik users will find a shortcut to Learningbank in the Ziik menu.

The name given to the integration during configuration will be shown on the button.

On web, it is shown in the left-hand menu. When clicked, it will open the Learningbank website on your organisation's platform.

On the app, it is listed under shortcuts at the bottom of the home screen.


Chat Communication Integration

Ziik notifications are available for communication notifications within the platform.

With the Ziik communication integration, you can send Learningbank notifications through Ziik and allow users to reply directly in the Ziik app.

Step 1: Create a Ziik user with Learningbank

  • In Ziik, create a User that will be the sender of notifications (e.g. "Academy").

  • Remember the email and password used.

Step 2: Configuration by Learningbank

Go to the Integration Hub in Learningbank and find Ziik.

Insert the credentials for the Ziik sender user you created in step 1.

Step 3: Access and customisation in your platform

  • Once the configuration is complete, you will find the notifications settings in your Learning lifecycle platform under the Organization tab -> Communication it is shown as a third notification type with Email and Push

  • Here you have the flexibility to adjust the notifications as needed:

    • Activation and deactivation of individual notification types (toggle notifications on/off)

    • Customizable text

Now you are ready to use Ziik notifications! ✉️

It will look like this in Ziik, whenever a message is received:

Good to know💭

  • When a notification is toggled on, the end-users will receive the notification through their Ziik app.

  • The end-users will be able to answer the notification messages, and you can initiate a chat or support them directly from your chosen Sender-User.

  • A pro of having the Sender-User is that you prevent users from being spammed with system-generated messages.

Did this answer your question?