The profile sync allows importing fields from your user database to the user profile in the app, such as company, biography or groups a user is part of. This article describes what the profile sync is and how it can be set up.
What is the profile sync?
Profile sync is an addition to a custom login. With the profile sync, you can sync more data from your system to a user's profile in the app.
For a basic custom login, only email address, first name and last name are required and synced from your system. Optionally, you can sync more profile fields, such as company or biography. Any fields that are supported in our system (see a full list below), can be mapped. The fields are populated after the user has successfully signed in and synced when the user accesses the event or her profile in the app. Please note that we need the same information as for the custom login to allow for the profile sync to work.
Please note that this sync is one-way, so users cannot change their details in the app andsync them back to your system. Instead, all imported fields are locked and cannot be edited in the app. When trying to edit such a field, a notification that redirects the user to her profile in the original user database opens. Changes can then be made there and then synced back into the app.
How to set it up
Further details for profile sync need to be estimated by the development team, and therefore discussed with your Customer Success Manager in advance.
To develop the profile sync, we need a working API with clear documentation and credentials from you. Furthermore, we need an overview of the profile data fields that should be synced and the mapping between the user profile fields in your database to the user profile fields that are supported on our platform. The following fields are supported:
- Email address (required)
- First name (required)
- Last name (required)
- Job title
The refresh token mechanism is supported as well. As access tokens may be valid for a short amount of time, the app can use a token to "refresh" the access token when it has expired. This way it's not needed for the user to sign in again, even though the access token of the first login has expired. This way the profile sync can still be done, even if the user hasn't opened the app for a while.