ngrok icon

CONNECT APP

Build with ngrok

API Gateway, IoT Device Gateway, Secure Tunnels for Containers, Apps & APIs

Developer Tools

  • API key

MCP

Give your agent ngrok tools

Every ngrok 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 ngrok account for each tool call — you store no tokens.

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

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

const { tools } = await mcp.listTools()

// e.g. run Create HTTPS Edge:
const result = await mcp.callTool({
  name: "ngrok-create-https-edge",
  arguments: {
    description: "Description",
    hostports: ["Host Ports"],
  },
})

API PROXY

Call the ngrok API directly

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

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

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

SDK

Run ngrok actions from your backend

Connect a user's ngrok account once, then run Create HTTPS Edge on their behalf from your own code — TypeScript, Python, or plain HTTP.

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: "ngrok-create-https-edge",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ngrok: { authProvisionId: "apn_xxxxxxx" },
    description: "Description",
    hostports: ["Host Ports"],
  },
})

EVENTS

ngrok triggers

Event sources your backend can deploy for users and receive through a webhook.

No ngrok triggers are available yet.

MULTI-APP

Use ngrok with other popular apps

Most products don't stop at one integration. Pair ngrok with the other apps your users rely on, and ship use cases that span both.

REFERENCE

App details

Reference metadata for the ngrok connector in the Pipedream registry.

App slug
ngrok
Authentication
API key
Categories
Developer Tools
Actions
4
Triggers
0
API proxy
Available