Importing your user profiles to Livefyre.
To associate users with their existing content in Livefyre, you must import user data from your user management system before importing any legacy content. Only user accounts with associated content need be imported. Any user accounts not imported before launch will be automatically imported from your User Profile system into the Livefyre system upon first login.
Importing user profile data follows the standards described for importing Comments, with a few exceptions. For more information on Import Format and the Import Process, please see Importing Content.
This section describes processes specific to the User Profile import process:
To begin the import process, you must prepare your import data. Livefyre’s import system expects a specific file format of line-delimited JSON Blobs, with each file representing a site on your network, and each line within the file representing an individual Collection on that site.
Similar to Content import, User Profile files adhere to these rules:
- Profile Blobs must appear on a single line and may not include any literal endlines other than a single one at the end of each Blob.
- The top level id field must be unique to the user.
- The file must be UTF-8 formatted, all URLs must be fully qualified, user timestamps must be ISO-8601 compliant.
Note: The files themselves are not valid JSON, but each line must be.
If you choose to import users from your existing user profile system, required fields include:
- id: your system’s user ID. It must match [a-zA-Z0-9-_])
- display_name:user’s display name or pseudonym which will be displayed on your public-facing site.
- email: required for Livefyre’s email notifications, this address is not visible on your public-facing site.
Use Livefyre’s Ping for Pull to update user fields after import. Ping Livefyre when one of your users updates their profile, then Livefyre will Pull down the requested user’s updated profile.Note: User avatars may be provided only through Ping for Pull and cannot be imported.
The following parameters are used in the User Profile import process.
- (required) string The user ID of the user in your profile system. This must be unique across all users in your Network, and must never change.
- (required) string The display name of the user. This will be rendered with Livefyre Content posted by the user.
- (optional) object Strings to define the user’s formatted, first, middle, and last names.
- (optional) string User’s email address. Used to send email notifications.
- (optional) array Used to assign users to user groups. Tags may include 1-63 alphanumeric and underscore characters.
- (optional) string URL to the user’s profile page on your site.
- (optional) string URL to a page where users may configure the user’s profile settings for your site.
- (optional) array An array of user-submitted sites. Max = 2.
- (optional) string A user-submitted location.
- (optional) string A user-submitted autobiography.
- (optional) Boolean Defines whether a user wishes to automatically follow a Collection after posting to it. When following a Collection, users receive email notifications when other users participate. May be true or false. Defaults to true.
- (optional) object Defines the frequency of available Livefyre email notifications. Different frequencies may be set for each notification type.
By default, no notifications will be sent.
immediately issues notifications immediately upon the listed event.
often issues notifications in batches.
never will not send email notification for the activity.
- comments: Defines when notifications are sent when other users post content into Collections that this user is following.
replies: Defines when notifications are sent when another user replies to this user’s content.
likes: Defines when notifications are sent when another user likes this user’s content.
moderator_comments: Defines when notifications are sent to moderators when users post content to any Collection in the Network.
moderator_flags: Defines when notifications are sent to moderators when other users flag content in any Collection in the Network.
Note: The following example lists both required and optional user profile import data.
"display_name": "John Smith",
"formatted": "John Michael Smith",
"tags": ["subscriber", "power_user"],
"location": "Washington D.C., USA",
"bio": "Bob Dole talks in the third person",