Importing Data

If you've just started using Stream, you might want to import data from your infrastructure or provider. Instead of using the APIs and creating your import scripts, you can make use of our import feature. 

The steps for importing data into your app are as follows:

1. Generate the import file for your data (full file reference below)

2. Reach out to send us the import file or upload via the dashboard

3. The file will be validated according to the rules described in this doc
4. If validation passes, a member of our team will approve and run the import
5. Once the import is completed (usually a few minutes), you will get a confirmation email

From your dashboard click on the ‘select app’ dropdown and select the app you wish to import chat data for. Then from the ‘chat’ dropdown click ‘Overview’. On the Overview screen click ‘Options’ and select ‘Import Chat Data’.

You will be presented with a modal asking for a JSON file. Please ensure you follow our best practices below to format this file before uploading.

Once you have uploaded your file scroll down on the chat overview page to see a ‘Data Import’ section. Here you can view some details about the file upload:

• The person who uploaded the file

• The date the file was uploaded

• The filename that was uploaded

• The current status of the upload

If your import fails validation on our end you can upload a new file by clicking on the ‘New Import’ button. To view more details of your import click on it within the list shown under ‘Data Imports’. This will show a modal where you can see the size of the import and a preview of the JSON that was uploaded.

If your import correctly passes our validations we will begin the migration process. This can typically take 2-3 days. An email will notify you once the upload has completed. The dashboard will also update showing a status of ‘completed’ within the ‘Data Imports’ table. 

Should your import fail we will be in touch via email. You will also see the status in the ‘Data Impots’ table update to the particular reason as to why the import failed.

The import file must be structured as a JSON array of objects. Each object is an item to add to your application (eg. a user, a message, etc.).

Here's an example of an import file:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
[ 
	{ 
		"type": "channel", 
		"item": { 
			"id": "6e693c74-262d-4d3d-8846-686364c571c8", 
			"type": "livestream", 
			"created_by": "aad24491-c286-4169-bbfc-9280de419cb6", 
			"name": "Rock'n Roll Circus" 
		} 
	}, 
	{ 
		"type": "message", 
		"item": { 
			"id": "977e691a-c091-4e3b-8f70-ba8944a3e500", 
			"channel_type": "livestream", 
			"channel_id": "6e693c74-262d-4d3d-8846-686364c571c8", 
			"user": "aad24491-c286-4169-bbfc-9280de419cb6", 
			"text": "Such a great song, check out my solo at 2:25", 
			"type": "regular", 
			"created_at": "2017-02-01T02:00:00Z", 
			"attachments": [ 
				{ 
					"type": "video", 
					"url": "https://www.youtube.com/watch?v=flgUbBtjl9c" 
				} 
			] 
		} 
	}, 
	{ 
		"type": "reaction", 
		"item": { 
			"message_id": "977e691a-c091-4e3b-8f70-ba8944a3e500", 
			"type": "love", 
			"user_id": "aad24491-c286-4169-bbfc-9280de419cb6", 
			"created_at": "2019-03-02T15:00:00Z" 
		} 
	} 
]

An import file can contain entries with any of these types.

The user type fields are shown below:

1
2
3
4
5
6
7
8
9
10
{ 
  "type": "user", 
  "item": { 
    "id": "aad24491-c286-4169-bbfc-9280de419cb6", 
    "name": "Jesse", 
    "image": "http://getstream.com", 
    "created_at": "2017-01-01T01:00:00Z", 
    "description": "Taj Mahal guitar player at some point" 
  } 
}

The channel type fields are shown below:

1
2
3
4
5
6
7
8
9
{ 
  "type": "channel", 
  "item": { 
    "id": "6e693c74-262d-4d3d-8846-686364c571c8", 
    "type": "livestream", 
    "created_by": "aad24491-c286-4169-bbfc-9280de419cb6", 
    "name": "Rock'n Roll Circus" 
  } 
}

Channel members store the mapping between users and channels. The fields are shown below:

1
2
3
4
5
6
7
8
9
10
{ 
  "type": "member", 
  "item": { 
    "channel_type": "livestream", 
    "channel_id": "6e693c74-262d-4d3d-8846-686364c571c8", 
    "user_id": "aad24491-c286-4169-bbfc-9280de419cb6", 
    "is_moderator": true, 
    "created_at": "2017-02-01T02:00:00Z" 
  } 
}

message creation time in RFC3339 format

last time the message was updated

message deletion time in RFC3339 format

reply messages are only shown inside the message thread unless show_in_channel is set to true, in that case the message is shown in the channel as well

Add as many custom fields as needed

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{ 
  "type": "message", 
  "item": { 
    "id": "977e691a-c091-4e3b-8f70-ba8944a3e500", 
    "channel_type": "livestream", 
    "channel_id": "6e693c74-262d-4d3d-8846-686364c571c8", 
    "user":"aad24491-c286-4169-bbfc-9280de419cb6", 
    "text": "Such a great song, check out my solo at 2:25", 
    "type": "regular", 
    "created_at": "2017-02-01T02:00:00Z", 
    "attachments": [ 
      { 
        "type": "video", 
        "url": "https://www.youtube.com/watch?v=flgUbBtjl9c" 
      } 
    ] 
  } 
}

The only required field of an attachment is "type". All other fields are optional, and you can add as many custom fields as you'd like. The attachments are a great way to extend Stream's functionality. If you want to have a custom product attachment, location attachment, checkout, etc., attachments are the way to go. The fields below are automatically picked up and shown by our component libraries.

The reaction type has the following fields:

1
2
3
4
5
6
7
8
9
{ 
  "type": "reaction", 
  "item": { 
    "message_id": "977e691a-c091-4e3b-8f70-ba8944a3e500", 
    "type": "love", 
    "user_id": "aad24491-c286-4169-bbfc-9280de419cb6", 
    "created_at": "2019-03-02T15:00:00Z" 
  } 
}