docs: add 4.5.0 automatic push integration flags to Android migration guide + README#520
Merged
glenn-klaviyo merged 8 commits intoJul 24, 2026
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe documentation adds SDK 4.5.0 migration guidance for Android automatic push open tracking and token forwarding manifest flags, including rollout defaults and anonymous profile behavior. The README updates its Anonymous Tracking section with corresponding token forwarding details. ChangesAutomatic push documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
glenn-klaviyo
added
the
SDK Auto Integration
…DME note - Add migration guide entry for `automatic_push_open_tracking` (opt-in, default off) and `automatic_push_token_forwarding` (default on, pending #516/MAGE-937 merge) - Token-forwarding entry is explicitly marked pending klaviyo-android-sdk#516; finalize on merge before releasing docs - Add two-stage rollout summary table covering both Android and iOS flags - Add anonymous-profile note to README Anonymous Tracking section Relates to MAGE-897. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
MAGE-937 (#516) is landing imminently; remove the "pending merge" note, heading suffix, and table caveat, and fix the README anchor link. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
glenn-klaviyo
force-pushed
the
docs/mage-897-native-sdk-migration-guide
branch
from
July 22, 2026 21:51
b75cbc9 to
fcc8cc1
Compare
Bare `#anonymous-tracking` fragment resolved against MIGRATION_GUIDE.md; link explicitly to ./README.md#anonymous-tracking. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@MIGRATION_GUIDE.md`:
- Around line 29-33: Correct the documentation to describe
automatic_push_token_forwarding as opt-in because an absent manifest value is
treated as false: update MIGRATION_GUIDE.md lines 29-33 to remove the default-on
wording and clarify manual control, update MIGRATION_GUIDE.md lines 48-49 to
show the 4.4.0 default as disabled, and update README.md lines 350-353 to remove
default-on and unconditional anonymous-profile claims.
- Around line 53-55: Update the anonymous-profile token-forwarding documentation
to describe the implementation-supported timing: the SDK fetches the current
token during initialization and when the app returns to the foreground, rather
than promising forwarding immediately on every FCM delivery. Apply this wording
change in MIGRATION_GUIDE.md lines 53-55 and README.md lines 351-352.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: db606898-0f7f-4c31-b537-46e0c1888d37
📒 Files selected for processing (2)
MIGRATION_GUIDE.mdREADME.md
Per maybeAutoRegisterPushToken (called from initialize and on app foreground) plus onNewToken: the SDK forwards the current token at initialization, on foreground, and on FCM token refresh — not only "as soon as FCM delivers one". Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The automatic push behaviors ship in the upcoming 4.5.0 minor, not 4.4.0. Updated the migration guide section and the README anonymous-profile note; left install snippets and unrelated version references untouched. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@MIGRATION_GUIDE.md`:
- Around line 5-6: Align all documented release references with the Android SDK
4.4.0 target: update the migration section and rollout table in
MIGRATION_GUIDE.md, and change the README.md SDK version qualifier to 4.4.0+. If
the intended release is actually 4.5.0, confirm and update the PR objective
instead.
- Around line 9-11: Update the SDK 4.5.0 introduction in MIGRATION_GUIDE.md to
clarify that automatic push-token forwarding is enabled by default. Explain that
integrations retaining manual token management may need to opt out or remove
redundant calls, while integrations accepting the default behavior require no
changes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 6d704781-4bdf-4845-a643-fa8a5879cde7
📒 Files selected for processing (2)
MIGRATION_GUIDE.mdREADME.md
- Remove iOS flag rows from the rollout summary (Android guide should not document iOS behavior). - Reword the intro to distinguish the opt-in open-tracking flag from the default-on token forwarding, and note the manual-control opt-out (addresses CodeRabbit). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
glenn-klaviyo
changed the title
Comment on lines
+15
to
+26
| ### `automatic_push_open_tracking` (opt-in, default **off**) | ||
|
|
||
| When enabled, the SDK automatically records push-open events without requiring you to call | ||
| `Klaviyo.handlePush` manually in your notification interaction handler. | ||
|
|
||
| To enable, add the following to the `<application>` element of your `AndroidManifest.xml`: | ||
|
|
||
| ```xml | ||
| <meta-data | ||
| android:name="com.klaviyo.push.automatic_push_open_tracking" | ||
| android:value="true" /> | ||
| ``` |
Contributor
There was a problem hiding this comment.
small thing, but I would put the instructions in the README, and point the migration guide to the README for how to opt in/out of the flag.
Author
There was a problem hiding this comment.
nice suggestion! will make this change
evan-masseau
approved these changes
Jul 24, 2026
evan-masseau
left a comment
evan-masseau
left a comment
Contributor
There was a problem hiding this comment.
Phrasing's fine, suggest swapping location of instructions
…here Per review feedback: configuration instructions (XML snippets) belong in the README alongside the existing Option A setup guide; the migration guide now links there instead of duplicating them. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds Android SDK 4.5.0 migration-guide and README documentation for the two automatic push-integration manifest flags. Android-only — iOS is covered separately in the Swift SDK (companion PR below).
Changes
MIGRATION_GUIDE.md— new# 4.5.0section (Android only):automatic_push_open_tracking— opt-in, default off. Enable viacom.klaviyo.push.automatic_push_open_tracking="true".automatic_push_token_forwarding— default on, opt out via="false". Formalizes the SDK's existing automatic token forwarding, so no action is required to preserve current behavior.README.md— Anonymous Tracking callout describing default-on token forwarding, with a link to the migration guide for opting out.Due Diligence
Release / Versioning
strings.xml). feat(push): default automatic_push_token_forwarding ON and gate onNewToken (MAGE-937) #516 (MAGE-937, default-on token forwarding) has merged.Test Plan
Verify rendered Markdown on GitHub; confirm manifest key names match the implementation.
Related Issues/Tickets
🤖 Generated with Claude Code