Migrating to Sendbird from Pusher Chatkit
Published : April 11, 2020
Prepared by : Solutions Engineering (Astin Choi)
With Sendbird, we make it easy to quickly perform a bulk migration of your user, channel and message chat data from Pusher’s Chatkit. Pusher is retiring their Chatkit product on April 23, 2020, but the SendBird team is ready to help you to migrate quickly! Tell us more about your chat migration by filling out this form here!
Develop quickly with Sendbird’s UIKit, our development kit with an user interface that enables an easy and fast integration of standard chat features into new or existing client apps. From the overall theme to individual styles such as colors and fonts, components can be fully customized to create an in-app chat experience unique to your brand identity.
1. Export your data from Pusher
- Export your data from Pusher. This data should consist of users, channels and messages.
Sign up for Sendbird and create your Sendbird applications.
We recommend creating two applications: one test/development application and one production application. Sendbird can perform a dry run of your migration data into your test/development application prior to migration into your production application so you can verify the data import. When choosing a server region for your applications, select the region that is the closest to your end-users.
- Share your intent to migrate to Sendbird. Fill out this form here.
2. Convert Pusher to Sendbird
Please refer to Pusher data format and Sendbird data format then convert your Pusher data to the Sendbird-readable data format. After converting it, contact us at email@example.com then we will give you SFTP account or AWS S3 info, validate your data and migrate it for you.
# (need Python version 3.x) $ git clone https://github.com/sendbird/migrating-from-pusher-chatkit $ cd migrating-from-pusher-chatkit $ pip3 install -r requirements.txt $ python3 pusher_to_sendbird.py
- Test the conversion script with the sample pusher files. (
- Remove all
_inputfiles and move the actual exported pusher files to
_outputfiles, and customize the script if needed.
- If you have files on pusher, you have to download them using the key and change the file name to UUID, then add some code to
pusher_to_sendbird.py. (For files, you can contact us. We will help you)
- Maximum of 10,000 users per file, up to 10 MB per file
- Required: Please confirm if you would like users to be issued an access_token or not with the SendBird team before your user migration
- User reference information
- Conversion grid
PUSHER SENDBIRD note id user_id name nickname avatar_url profile_url - profile_file if you have avatar files, you can name it using UUID metadata custom_data
- Maximum of 1,000 channels per file, up to 10 MB per file
- Can be used to populate channel information, even if the channel does not have any messages
- Message reference information
- Conversion grid
PUSHER SENDBIRD note rooms.json id channel_url name name created_by_id - member_ids members push_notification_title_override - private is_public custom_data data (or custom_type) If you want to filter channels by custom_type, you can use custom_type created_at created_at - cover_url messages.json id dedup_id sender_id user_id created_at (or updated_at) ts parts - ‘inline’ type (only) = MESG type ‘inline, url, and attachment’ type = FILE type
3. Prepare your app with SendBird SDK
While your data is importing into SendBird, begin development of a new version of your application running with the SendBird SDK. Find our getting started guides and sample apps below. Use our UI Kit to develop your app in minutes!
- UIKit for React
- Quick Start Guide
- Sample Apps for Web and React Native
- See the Sample Apps running in action here!
4. Deploy app code with SendBird SDK
After your data import is complete, it’s time to release the new app with SendBird SDK. If possible, we recommend force-updating your users to the new app version to quickly move all users to chat running with SendBird.
If it is not possible to immediately force-update users in your application, we recommend getting in touch with us if this is your must-have use case so we can discuss and provide assistance in moving forward.
- User id: A string with a length of 80 and can be the same as the user id that was used in Chatkit. This will be the unique id that can be used to identify the user and we don’t allow duplicate id in an app.
- Metadata: Map your Chatkit user custom_data to user metadata in SendBird. If you want to add custom information such as organization id for the B2B case, you can use this resource. You can filter users based on this value to limit their access to a certain group of users. Find more information on user metadata here.
- Access Token/Session Token: Users can still have access tokens as in Chatkit, but these are not required by default in SendBird. For ease of migration, we recommend adjusting your access token policy after migration is complete. Access tokens or session tokens require your system to save this value for future login to SendBird for this user. Learn more on access tokens and session tokens here.
SendBird supports text and file messages for migration and maps them to SendBird MESG and FILE message types.
Learn more about message types here. A SendBird message is not broken into multiple parts like a message in Chatkit, so we recommend that a message with link or attachment parts is mapped to SendBird’s FILE message type.
- Custom Type: You can use this field to subclassify messages. This field can be used for querying messages.
- Data: Reserved for adding custom data information used for clients. The data field stores string type data and customers can use JSON or XML to serialize data into the string.
- Dedup id: A unique id from the legacy system. A duplicate check will be performed on this field so it prevents the same data from getting inserted.
- Created at: Instead of the timestamp set at the saving step, you should assign the original value from the legacy system.
- File message: The file message can include the data of the file to upload to the SendBird server in raw binary format or the URL to the file.
For every Room in Chatkit, there’s a SendBird channel available. SendBird supports Group Channels designed for chats with user membership similar to Room Membership in Chatkit. Group Channels can include 1-1 chats or 1-N chats with multiple members, and Group Channels can be public or private.
SendBird also supports Open Channels intended for large, public chats that users participate in during their active chat session. Learn more about channel types here.
During migration, when the channel is not found, SendBird creates a channel first and then starts adding messages.
- Channel URL: If you pass “channel_url” as the legacy system’s channel identifier, then you don’t have to save mapping info between legacy channels and SendBird channels. The channel_url is a unique identifier in your app so a duplicate channel URL will not be allowed.
- Data: Reserved for adding custom data information used for clients. The data field stores string type data and customers can use JSON or XML to serialize data into the string. You can also add origin information to mark that it was migrated.
- Custom Type: This value helps subclassify channels. This field can be used for querying channels. Tip- If the organization that your apps support have a hierarchy, give the customer type as higher_organization_name_sub_organization_name ex. macy_sanfrancisco. You can query channels based on custom_type_equal or custom_type_starts_with operator.