CONNECT APP

Build with ReferralHero

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

Marketing

API key

Visit ReferralHero ↗ Start building

MCP

Give your agent ReferralHero tools

Every ReferralHero action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's ReferralHero account for each tool call — you store no tokens.

Pipedream Connect

// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": "{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",
  },
})

# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
    "Authorization": f"Bearer {access_token}",
    "x-pd-project-id": "{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",
}

async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
    async with ClientSession(read, write) as session:
        await session.initialize()
        tools = await session.list_tools()

        # e.g. run Add Subscriber:
        result = await session.call_tool("referralhero-add-subscriber", {
            "listId": "List",
            "email": "Email",
        })

MCP guide →

API PROXY

Call the ReferralHero API directly

For an endpoint with no pre-built tool, the Connect proxy forwards your request to the ReferralHero API with the connected user's credentials attached. You store no tokens and write no refresh logic.

Pipedream Connect

const resp = await pd.proxy.get({
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  accountId: "apn_xxxxxxx",
  url: "https://app.referralhero.com/api/v2/lists",
})

// Any allowed ReferralHero endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.

# 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"

API proxy guide →

SDK

Run ReferralHero actions from your backend

Connect a user's ReferralHero account once, then run Add Subscriber on their behalf from your own code — TypeScript, Python, or plain HTTP.

Pipedream Connect

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",
  },
})

from pipedream import Pipedream

pd = Pipedream(
    client_id="{oauth_client_id}",
    client_secret="{oauth_client_secret}",
    project_id="{project_id}",
    project_environment="production",
)

result = pd.actions.run(
    id="referralhero-add-subscriber",
    external_user_id="{external_user_id}",  # any stable ID for this user in your system
    configured_props={
        "referralhero": {"authProvisionId": "apn_xxxxxxx"},
        "listId": "List",
        "email": "Email",
    },
)

curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "referralhero-add-subscriber",
    "configured_props": {
      "referralhero": { "authProvisionId": "apn_xxxxxxx" },
      "listId": "List",
      "email": "Email"
    }
  }'