View as Markdown
ReferralHero icon

ReferralHero ACTION

Track Referral Conversion Event

Track a referral conversion event. Use when your Campaign Goal is set to track two or three conversion events. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ReferralHero account once, then configure and run Track Referral Conversion 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: "referralhero-track-referral-conversion-event",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    referralhero: { authProvisionId: "apn_xxxxxxx" },
    listId: "List",
    subscriber: "Subscriber",
  },
})

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.

Track Referral Conversion Event inputs
Property Type Description
listId List string
Identifier of a list
Required Dynamic
subscriber Subscriber string
Email address of a subscriber
Required Dynamic
referrer Referrer string
The unique identifier of the referrer
Required

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
referralhero-track-referral-conversion-event
Version
0.0.3
App
ReferralHero
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes