Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BD-2016: Clarify push token requirements for migration #5126

Merged
merged 1 commit into from
Mar 31, 2023
Merged

BD-2016: Clarify push token requirements for migration #5126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions _docs/_help/help_articles/push/push_token_migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ channel: push

# Migrating push tokens

A [push token]({{site.baseurl}}/user_guide/message_building_by_channel/push/push_registration/#push-tokens/) is a unique anonymous identifier that specifies where to send an app's notifications. Push token migration is the process of importing these previously-created keys into your Braze platform through the API.
A [push token]({{site.baseurl}}/user_guide/message_building_by_channel/push/push_registration/#push-tokens/) is a unique anonymous identifier that specifies where to send an app's notifications. Braze connects with push service providers like Firebase Cloud Messaging Service (FCMs) for Android and Apple Push Notification Service (APNs) for iOS, and those providers send unique device tokens that identify your app.

Push token migration is the process of importing these previously-created keys into your Braze platform through the API.

If you are a customer who was previously sending push notifications, either on your own or through another provider, push token migration allows you to continue sending push notifications to your users with registered push tokens during the SDK implementation process. Once the Braze SDKs are put in place, they handle push tokens automatically with no need to migrate them via the API.

## Migration via API

Programmatically migrate iOS and Android push tokens to your platform by using the [`users/track`]({{site.baseurl}}/api/endpoints/user_data/post_user_track/) endpoint. You can migrate both identified users (users with an associated `external_id`) and anonymous users (users without an `external_id`).
Programmatically migrate iOS (APNs) and Android (FCM) tokens to your platform by using the [`users/track`]({{site.baseurl}}/api/endpoints/user_data/post_user_track/) endpoint. You can migrate both identified users (users with an associated `external_id`) and anonymous users (users without an `external_id`).

You need to specify your app's `app_id` during push token migration to associate the appropriate push token with the appropriate app. Each app (iOS, Android, etc.) has its own `app_id`, which can be found in the **Developer Console**, under the **API Settings** tab in the **Identification** section. Be sure to use the correct platform's `app_id`.

Expand All @@ -29,7 +31,6 @@ It is not possible to migrate web push tokens through the API. This is because w
As an alternative to API migration, we recommend that you integrate the SDK and allow your token base to repopulate naturally.
{% endalert %}


### Migration if external ID is present
For identified users, set the `push_token_import` flag to `false` (or omit the parameter) and specify the `external_id`, `app_id`, and `token` values in the user `attributes` object.

Expand Down Expand Up @@ -108,4 +109,4 @@ You must have a receiver to handle and display push payloads. To notify the rece
For some push notification providers, Braze will need to flatten the key-value pairs so that they can be properly interpreted. To flatten key-value pairs for a specific Android app, contact your Customer Onboarding or Success Manager.
{% endalert %}

_Last updated on December 5, 2022_
_Last updated on December 5, 2022_