-
Notifications
You must be signed in to change notification settings - Fork 10
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.
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
[DI-6248] Update event documentation #7491
Conversation
We require contributors to sign our Contributor License Agreement, and we don't have you on file. In order for us to review and merge your code, please fill out the information here. To re-call the cla-bot, comment |
@cla-bot check |
The cla-bot has been summoned, and re-checked this pull request! |
f2bfc75
to
2f7da0d
Compare
2f7da0d
to
64c6722
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @isturdy ! Overall, the PR looks good to me! I have a few edits but they're pretty duplicative across the events:
External ID of the user
instead ofExternal user ID of the user
e.164 format
instead ofe164 format
Description of error from WhatsApp
instead ofDescription of failure from WhatsApp
ID of the card this in-app message comes from
instead ofID of the card this in app message comes from
There are also some extra periods in the field descriptions that we can remove as well from the Mixpanel events
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md
Show resolved
Hide resolved
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md
Show resolved
Hide resolved
64c6722
to
8d8af03
Compare
_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md
Outdated
Show resolved
Hide resolved
Automatically generated event documentation reflecting changes in currents-users-events
356217a
to
6fdac9a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lgtm!
Pull Request/Issue Resolution
Description of Change:
This updates the event payload documentation for Currents with one automatically generated from the event config. Aside from fixing some inconsistencies, this allows accurate event structures for all destinations, not merely storage ones.
Is this change associated with a Braze feature/product release?
✔️ Pull Request Checklist
assets
>js
>broken_redirect_list.js
⭐ Helpful Wiki Shortcuts
❗ ATTN: For PR Reviewers
❗ ATTN: Internal Reviewing Chart
Work at Braze and not sure who to tag for review?
Before tagging @josh-mccrowell-braze or @internetisaiah for a general review, reference the following chart to see if a specific product vertical/reviewer applies to your pull request.
Quality Infrastructure
Platform Infrastructure
Datalake
SDKs
Currents
Technology partners
Channels
In-App Messages
Channels
Frontend Infrastructure & Experience (FIX)
Core Objects
Core Messaging
Messaging Experience
Message Components
Email (Composition and Infrastructure) (tag @rachel-feinberg for Liquid use cases)
SMS
User Targeting
Reporting