# ReferralHero — Pipedream Connect

> Everything you need to build, manage, and track a referral program‍... that doubles your business.

- API slug: `referralhero` (use in MCP headers and tool keys)
- Auth: API key (Pipedream-managed)
- Categories: Marketing
- Website: https://referralhero.com/
- This page (HTML): https://pipedream.com/apps/referralhero
- Tools: 3 actions · 1 trigger

## Connect via MCP (recommended)

- Endpoint: `https://remote.mcp.pipedream.net/v3`
- Headers: `Authorization: Bearer <token>` · `x-pd-project-id` · `x-pd-environment` · `x-pd-external-user-id` · `x-pd-app-slug: referralhero`

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "referralhero",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Add Subscriber:
const result = await mcp.callTool({
  name: "referralhero-add-subscriber",
  arguments: {
    listId: "List",
    email: "Email",
  },
})
```

Docs: [MCP guide](https://pipedream.com/docs/connect/mcp/developers.md)

## API proxy

For a ReferralHero endpoint with no pre-built tool, the proxy forwards your request with the connected user's credentials attached.

```bash
# The path segment is the target URL, URL-safe base64 encoded:
# https://app.referralhero.com/api/v2/lists

curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcHAucmVmZXJyYWxoZXJvLmNvbS9hcGkvdjIvbGlzdHM?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: production"
```

Docs: [API proxy guide](https://pipedream.com/docs/connect/api-proxy.md)

## SDK

```ts
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-add-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    referralhero: { authProvisionId: "apn_xxxxxxx" },
    listId: "List",
    email: "Email",
  },
})
```

Docs: [Managed auth guide](https://pipedream.com/docs/connect/managed-auth/quickstart.md) · [Tools guide](https://pipedream.com/docs/connect/components.md)

## Actions (3)

### `referralhero-add-subscriber` — Add Subscriber (Write)

Adds a new subscriber to to a list. See the documentation

Full schema: https://pipedream.com/apps/referralhero/actions/add-subscriber.md

### `referralhero-list-list-id-options` — List List Options (Read-only)

Retrieves available options for the List field.

Full schema: https://pipedream.com/apps/referralhero/actions/list-list-id-options.md

### `referralhero-track-referral-conversion-event` — Track Referral Conversion Event (Write)

Track a referral conversion event. Use when your Campaign Goal is set to track two or three conversion events. See the documentation

Full schema: https://pipedream.com/apps/referralhero/actions/track-referral-conversion-event.md

## Triggers (1)

### `referralhero-new-subscriber-added` — New Subscriber Added (Polling)

Emit new event when a new subscriber is added

Full schema: https://pipedream.com/apps/referralhero/triggers/new-subscriber-added.md

---

- All apps: https://pipedream.com/apps — index: https://pipedream.com/llms.txt
- Pipedream docs for agents: https://pipedream.com/docs/llms.txt