Sby Segment
Associate a user with a group
Ties an identified user to a group, such as a company or account, and records the group's traits like industry and employee count.
Description
Send `userId` or `anonymousId`, the `groupId`, and the group's `traits`. Destinations that model accounts, such as Intercom, use it to tie users to their company. `SEGMENT_API_KEY` holds the base64 of the source's write key followed by a colon.
associate-user-with-group.md
Associate a user with a group
Ties an identified user to a group, such as a company or account, and records the group's traits like industry and employee count.
Send userId or anonymousId, the groupId, and the group's traits.
Destinations that model accounts, such as Intercom, use it to tie users to
their company. SEGMENT_API_KEY holds the base64 of the source's write key
followed by a colon.
Set up
Use the first option your agent supports.
API (official)
- Base URL: https://api.segment.io
- Endpoint:
POST /v1/group - Auth: send the header
Authorization: Basic $SEGMENT_API_KEY - Get a key: https://www.twilio.com/docs/segment/connections/find-writekey
- Docs: https://www.twilio.com/docs/segment/connections/sources/catalog/libraries/server/http-api
Before doing anything else, make one read-only call to confirm access.
Rules
- Ask the user before anything that sends messages, costs money, or changes data.
- Never print API keys.
Built from these files in the repository
The layout and the rules come from lib/catalog/render-markdown.ts, the set-up wording from lib/catalog/render-access.ts.
Ways in
| Route | Source | Call | Required | Docs |
|---|---|---|---|---|
| Official | POST /v1/group | API key in $SEGMENT_API_KEY | Docs |