View as Markdown
Dreamdata icon

Dreamdata ACTION

Identify User

Tie a user to their actions and record traits about them. Either a User ID or an Anonymous ID is required. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Dreamdata account once, then configure and run Identify User 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: "dreamdata-identify-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    dreamdata: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
    anonymousId: "Anonymous ID",
  },
})

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.

Identify User inputs
Property Type Description
userId User ID string
Unique identifier for the user in your database. Either a User ID or an Anonymous ID is required.
Optional
anonymousId Anonymous ID string
A pseudo-unique substitute for a User ID, for cases when you don't have an absolutely unique identifier. Either a User ID or an Anonymous ID is required.
Optional
traits Traits object
Free-form dictionary of traits about the user, e.g. { "email": "jane@acme.com", "name": "Jane Doe", "title": "VP Sales" }.
Optional
messageId Message ID string
A unique identifier for this message. Defaults to a generated UUID if omitted. Use a deterministic value to make calls idempotent. Example: msg_order_2026_05_27_0001.
Optional
timestamp Timestamp string
ISO-8601 timestamp when the event took place. Defaults to the current time if omitted. Example: 2026-05-27T17:32:11.318Z.
Optional
context Context object
Dictionary of extra information about the message that is not directly related to the API call, such as IP address, user agent, page, or campaign UTM parameters. Example: { "ip": "203.0.113.1", "userAgent": "Mozilla/5.0", "page": { "url": "https://example.com/pricing" }, "campaign": { "utm_source": "google" } }. See Segment-compatible context spec.
Optional
integrations Integrations object
Dictionary of downstream destinations to either enable or disable for this event. Example: { "all": false, "Google Analytics": true, "HubSpot": false }.
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
dreamdata-identify-user
Version
0.0.2
App
Dreamdata
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes