View as Markdown
Segment icon

Segment ACTION

Associate an identified user with a group

Group lets you associate an identified user with a group (note requires userId or anonymousId). See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Segment account once, then configure and run Associate an identified user with a group from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "segment-group",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    segment: { authProvisionId: "apn_xxxxxxx" },
    anonymousId: "Anonymous ID",
    context: "Context",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Associate an identified user with a group inputs
Property Type Description
anonymousId Anonymous ID string
A pseudo-unique substitute for a User ID, for cases when you don't have an absolutely unique identifier. A User ID or an Anonymous ID is required.
Optional
context Context object
Dictionary of extra information that provides useful context about a message, but is not directly related to the API call like ip address or locale
Optional
groupId Group ID string
A unique identifier for the group in your database.
Required
integrations Integrations object
Dictionary of destinations to either enable or disable
Optional
timestamp Timestamp string
Timestamp when the message itself took place, defaulted to the current time by the Segment Tracking API. It is an ISO-8601 date string. For example, 2022-04-08T17:32:11.318Z
Optional
traits Traits object
Free-form dictionary of traits of the group, like email or name.
Optional
userId User ID string
Unique identifier for the user in your database., A User ID or an Anonymous ID is required.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
segment-group
Version
0.2.6
App
Segment
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes