Update sample code for Node.js Typewritter #5538
Merged
Conversation
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
forstisabella
approved these changes
Dec 4, 2023
|
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Proposed changes
In the Typewriter Node.js quickstart, there is a code example issuing a Typewriter track call with an example payload that includes two event properties as top-level keys: https://segment.com/docs/protocols/apis-and-extensions/typewriter/#nodejs-quickstart
However, this payload is invalid; the underlying analytics-node package requires a slightly different structure for event params (requires "userId" or "anonymousId" top-level parameters, and event properties must be nested under a key of "properties"): https://github.com/segmentio/analytics-next/tree/master/packages/node#usage
Merge timing
ASAP once approved