Segment

Track events and identify users with Segment CDP.

AnalyticsAPI key1 actionAll integrations

On this page

Connect
Call it from a workflow
Actions (1)
identifyUser
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("segment", "identifyUser", {
    "userId": "<user id>",
    "traits": {}
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Segment answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "segment-identifyuser",
  name: "Segment: Identify User",
  description: "Calls Segment when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("segment", {
      "action": "identifyUser",
      "userId": "<user id>",
      "traits": {}
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/segment/identifyUser" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"userId":"<user id>","traits":{}}}'

Actions

identifyUserin catalog

Identify User.

Input	Type	Description
`userId`required	text	User ID
`traits`required	object	The traits to associate with the user

Details

Id: segment
Category: Analytics
Tags: cdp, analytics, tracking, data-pipeline
Package: @activepieces/piece-segment@0.1.3
Tier: Community