[BD-5509] Update order of Currents examples #11467
Conversation
|
🤖 Automated Reviewer Assignment: I have automatically added reviewers based on the following:
|
There was a problem hiding this comment.
Pull request overview
This PR reorders the Currents event glossary examples to prioritize Cloud Storage by placing its tab first, before other integration examples (Amplitude, Segment, mParticle, Mixpanel). This organizational change makes Cloud Storage examples more discoverable for users.
Key Changes
- Moved Cloud Storage tab to first position across all event types in both glossary files
- No content changes—only tab ordering was modified
- Applied consistently to all events in both message engagement and customer behavior glossaries
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
message_engagement_events.md |
Reordered Cloud Storage tab to appear first for all message engagement events (Uninstall, Subscription, Campaign Conversion, Canvas events, Banner events, Content Card events, Email events, Feature Flags, In-App Messages, LINE, Live Activity, Push Notifications, RCS, SMS, Webhooks, WhatsApp) |
customer_behavior_events.md |
Reordered Cloud Storage tab to appear first for all customer behavior events (Custom Events, Attribution, Location, Purchase, Session events, Live Activity Token events, Push Token State Change) |
Review Complete: No issues found. The changes are purely structural and improve documentation usability by prioritizing the Cloud Storage integration examples. The reordering is applied consistently across all event types in both files.
| Live Activity, Update Token | ||
| {% endapitags %} | ||
|
|
||
| This event occurs when Braze syncs Live Activity update token with the user |
There was a problem hiding this comment.
should this say "...the Live Activity update token..."?
| Push, Token State Change | ||
| {% endapitags %} | ||
|
|
||
| This event occurs when a push token is inserted, updated or removed. Use this to track the states of push tokens. |
There was a problem hiding this comment.
Add a series comma to say, "...inserted, updated**,** or removed."
| Canvas | ||
| {% endapitags %} | ||
|
|
||
| This event occurs when a user convert for a Canvas experiment step. |
There was a problem hiding this comment.
Should this say, "...when a user converts for a Canvas..."?
|
|
||
| #### Property details | ||
|
|
||
| - `dispatch_id` is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same `dispatch_id`. Use `dispatch_id` to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open). |
There was a problem hiding this comment.
I think I read above that dispatch_id is deprecated and will be removed in the next Current release. Should we have a similar note here?
| This event occurs when the end-user has clicked "unsubscribe" from the email. | ||
|
|
||
| {% alert important %} | ||
| The `Unsubscribe` event is actually a specialized click event that is fired when your user clicks on the unsubscribe link in the email (either a normal unsubscribe link within the email body or footer, or using the [list-unsubscribe header]({{site.baseurl}}/user_guide/administrative/app_settings/manage_app_group/email_settings#include-a-list-unsubscribe-header)), not when the user changes state to unsubscribed. If subscription state change is sent through the API, or via custom (non-Braze) unsubscription link, it will not trigger an event on Currents. |
There was a problem hiding this comment.
- Consider removing "actually" -- filly text that's not necessary
- Change "clicks on" to simply "clicks"
| Live Activity, Sends | ||
| {% endapitags %} | ||
|
|
||
| This event occurs when Braze backend makes a request to its provider regarding Live Activity |
There was a problem hiding this comment.
Hmm, this wording gave me pause. Not sure it's wrong, but wondering if we can clean it up a bit. Consider maybe:
- "...when the Braze backend..."
- or, to avoid the term
backendaltogether, maybe "...when the Braze system..."?
| RCS, Sends | ||
| {% endapitags %} | ||
|
|
||
| This event is created when an RCS messages is sent out of Braze to our last-mile delivery partners. |
There was a problem hiding this comment.
Update to "...when an RCS message..." (singular)
| @@ -10887,6 +10932,7 @@ This event occurs when an SMS is sent to the carrier. | |||
| "external_user_id" : "(optional, string) [PII] External ID of the user", | |||
| "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", | |||
| "id" : "(required, string) Globally unique ID for this event", | |||
| "is_sms_fallback" : "(optional, boolean) Indicates that a SMS fallback message was sent due to a rejected RCS message. The message could result in delivery, delivery failure, or rejection. It can be linked to the RCS Rejection event via a send ID and dispatch ID", | |||
There was a problem hiding this comment.
Above, we say "an SMS" and here we say "a SMS". I tend to favor "an SMS", but whatever we go with, consistency is key.
| SMS, Rejection | ||
| {% endapitags %} | ||
|
|
||
| This event occurs when an SMS send gets rejected by the carrier, this can happen for several reasons. Use this event and the provided error codes to help troubleshoot issues with SMS delivery. |
There was a problem hiding this comment.
The first sentence in this line should probably be two separate sentences.
Why are you making this change? (required)
Update order of Currents examples to lead with Cloud Storage for Customer behavior and user events and Message engagement events glossaries
Related PRs, issues, or features (optional)
Feature release date (optional)
Contributor checklist
Submitting for review
If your PR meets the above requirements, select Ready for review, then add a reviewer:
@braze-inc/docs-teamin a comment below.braze-inc/docs-teaminstead.Thanks for contributing! We look forward to reading your work.