Segment Managed Component
Find out more about Managed Components here for inspiration and motivation details.
🚀 Quickstart local dev environment
- Make sure you're running node version >=18.
- Install dependencies with
npm i - Run unit test watcher with
npm run test:dev
⚙️ Tool Settings
Settings are used to configure the tool in a Component Manager config file
Segment Source Write Key string required
writeKey - You need to create an HTTP API source, and enter the Write Key here. Learn more
Type string required
callType - Options are:
- Page - Record page views on your website
- Track - Record the actions your users perform
- Identify - Tie a user to their actions
- Alias - Associate one identity with another identity
- Group - Associate an individual user with a group
🧱 Fields Description
Event Name string required
event - Name of the action that a user has performed. See the Event field docs for more details.
Page Name string
name - Name of the page. For example, most sites have a "Signup" page that can be useful to tag, so you can see users as they move through your funnel.
Anonymous ID string
anonymousId - A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier. See the Identities docs for more details.
User ID string
userId - Unique identifier for the user in your database. See the Identities docs for more details.
Previous ID string
previousId - The existing ID you’ve referred to the user by. It might be an Anonymous ID assigned to that user or a User ID you previously identified them with.
📝 License
Licensed under the Apache License.
💜 Thanks
Thanks to everyone contributing in any manner for this repo and to everyone working on Open Source in general.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!