View as Markdown
Engage icon

Engage ACTION

Add Event

Adds user events to Engage. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Engage account once, then configure and run Add Event 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: "engage-add-event",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    engage: { authProvisionId: "apn_xxxxxxx" },
    uid: "User ID",
    event: "Event",
  },
})

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.

Add Event inputs
Property Type Description
uid User ID string
ID of the user
Required Dynamic
event Event string
The name of the event associated with the user
Required
value Value string
The event value
Required
timestamp Timestamp string
Timestamp of the event. If none is provided, the current time is used
Optional
properties Properties object
The properties of the event
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
engage-add-event
Version
0.0.2
App
Engage
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes