# Hyperise — Pipedream Connect

> 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.

- API slug: `hyperise` (use in MCP headers and tool keys)
- Auth: API key (Pipedream-managed)
- Categories: Marketing
- Website: https://hyperise.com/
- This page (HTML): https://pipedream.com/apps/hyperise
- Tools: 2 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: hyperise`

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

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

## API proxy

For a Hyperise 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.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"
```

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

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

## Actions (2)

### `hyperise-create-personalised-short-link` — Create Personalised Short Link (Write)

Creates a personalised short URL from provided inputs. See the documentation

Full schema: https://pipedream.com/apps/hyperise/actions/create-personalised-short-link.md

### `hyperise-list-image-template-hash-options` — List Image Template Hash Options (Read-only)

Retrieves available options for the Image Template Hash field.

Full schema: https://pipedream.com/apps/hyperise/actions/list-image-template-hash-options.md

## Triggers (1)

### `hyperise-new-image-impression` — New Image Impression (Polling)

Emit new event when a new personalised image is viewed. See the documentation

Full schema: https://pipedream.com/apps/hyperise/triggers/new-image-impression.md

---

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