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.

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

Merged
merged 1 commit into from
Jun 20, 2024
Merged

Conversation

isturdy
Copy link
Contributor

@isturdy isturdy commented Jun 8, 2024

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?

  • Yes (Insert Feature Release Date Here)
  • No

✔️ Pull Request Checklist
  • Check that you haven't removed any images (replacing an image with an updated one of the same name is fine), as this breaks the French site
  • Check that all links work.
  • Ensure you have completed our Contributors License Agreement.
  • Tag @josh-mccrowell-braze and @internetisaiah as a reviewer when your work is done and ready to be reviewed for merge. Are you an internal product manager? Reference the internal reviewing chart to tag the appropriate reviewer.
  • If the documentation involves a 1) paid SKU, 2) a third party, 3) SMS, 4) AI, or 5) privacy, ensure that Ana Teresa Serafino on the Legal team has signed off.
  • Tag others as reviewers as necessary.
  • If you have modified any links, be sure to add redirects to assets > js > broken_redirect_list.js
⭐ Helpful Wiki Shortcuts
❗ ATTN: For PR Reviewers
  • Read our Reviewing a PR page for more on our reviewing suggestions.
  • Read our Previewing Documentation page to see how to check the deployment.
    • Preview all changes in the linked Vercel environment by clicking the preview link in the vercel-bot comment in your PR.
❗ 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.

Reviewer Product Vertical
@josh-mccrowell-braze Monolith Deployments
Quality Infrastructure
Platform Infrastructure
Datalake
SDKs
Currents
@internetisaiah Developer Guide
Technology partners
Channels
@bre-fitzgerald Intelligence
In-App Messages
Channels
Frontend Infrastructure & Experience (FIX)
@lydia-xie Ingestion
Core Objects
Core Messaging
Messaging Experience
Message Components
Email (Composition and Infrastructure) (tag @rachel-feinberg for Liquid use cases)
@rachel-feinberg Customer Lifecycle, Identity and Permissions
SMS
User Targeting
Reporting

Copy link

cla-bot bot commented Jun 8, 2024

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.

@lydia-xie lydia-xie self-assigned this Jun 10, 2024
@isturdy
Copy link
Contributor Author

isturdy commented Jun 14, 2024

@cla-bot check

@cla-bot cla-bot bot added the cla-signed label Jun 14, 2024
Copy link

cla-bot bot commented Jun 14, 2024

The cla-bot has been summoned, and re-checked this pull request!

Copy link
Contributor

@lydia-xie lydia-xie left a 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 of External user ID of the user
  • e.164 format instead of e164 format
  • Description of error from WhatsApp instead of Description of failure from WhatsApp
  • ID of the card this in-app message comes from instead of ID 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

@rachel-feinberg rachel-feinberg self-requested a review June 20, 2024 15:46
@alexandre-bolduc-braze alexandre-bolduc-braze changed the title [D-6248] Update event documentation [DI-6248] Update event documentation Jun 20, 2024
Automatically generated event documentation reflecting changes in currents-users-events
Copy link
Contributor

@rachel-feinberg rachel-feinberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm!

@rachel-feinberg rachel-feinberg merged commit ecda2ad into develop Jun 20, 2024
3 checks passed
@rachel-feinberg rachel-feinberg deleted the update-event-docs branch June 20, 2024 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants