CONNECT APP

Build with Hyperise

Hyperise is essentially an image personalisation toolkit. These images can be used in outreach and on your website landing pages. Hyperise integrates with 1000's of MarTech, so whatever your outreach and website builder tools you're using, we most likely integrate with them.

Marketing

API key

Visit Hyperise ↗ Start building

MCP

Give your agent Hyperise tools

Every Hyperise 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 Hyperise 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": "hyperise",
      },
    },
  },
)

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

const { tools } = await mcp.listTools()

// e.g. run Create Personalised Short Link:
const result = await mcp.callTool({
  name: "hyperise-create-personalised-short-link",
  arguments: {
    imageTemplateHash: "Image Template Hash",
    destinationUrl: "Destination URL",
  },
})

# 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": "hyperise",
}

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 Create Personalised Short Link:
        result = await session.call_tool("hyperise-create-personalised-short-link", {
            "imageTemplateHash": "Image Template Hash",
            "destinationUrl": "Destination URL",
        })

MCP guide →

API PROXY

Call the Hyperise API directly

For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Hyperise 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.hyperise.io/api/v1/regular/users/current",
})

// Any allowed Hyperise 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.hyperise.io/api/v1/regular/users/current

curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcHAuaHlwZXJpc2UuaW8vYXBpL3YxL3JlZ3VsYXIvdXNlcnMvY3VycmVudA?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 Hyperise actions from your backend

Connect a user's Hyperise account once, then run Create Personalised Short Link 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: "hyperise-create-personalised-short-link",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hyperise: { authProvisionId: "apn_xxxxxxx" },
    imageTemplateHash: "Image Template Hash",
    destinationUrl: "Destination URL",
  },
})

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="hyperise-create-personalised-short-link",
    external_user_id="{external_user_id}",  # any stable ID for this user in your system
    configured_props={
        "hyperise": {"authProvisionId": "apn_xxxxxxx"},
        "imageTemplateHash": "Image Template Hash",
        "destinationUrl": "Destination URL",
    },
)

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": "hyperise-create-personalised-short-link",
    "configured_props": {
      "hyperise": { "authProvisionId": "apn_xxxxxxx" },
      "imageTemplateHash": "Image Template Hash",
      "destinationUrl": "Destination URL"
    }
  }'