CONNECT APP
Build with ngrok
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"],
},
})# 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": "ngrok",
}
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 HTTPS Edge:
result = await session.call_tool("ngrok-create-https-edge", {
"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.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.ngrok.com/api_keys
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkubmdyb2suY29tL2FwaV9rZXlz?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"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"],
},
})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="ngrok-create-https-edge",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"ngrok": {"authProvisionId": "apn_xxxxxxx"},
"description": "Description",
"hostports": ["Host Ports"],
},
)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": "ngrok-create-https-edge",
"configured_props": {
"ngrok": { "authProvisionId": "apn_xxxxxxx" },
"description": "Description",
"hostports": ["Host Ports"]
}
}'TOOLS
ngrok actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create HTTPS Edge
actionCreate an HTTPS Edge. See the documentation.Writev0.0.2 -
Delete HTTPS Edge
actionDelete an HTTPS Edge. See the documentation.Writev0.0.2 -
Get HTTPS Edge
actionGet the details of an HTTPS Edge. See the documentation.Read-onlyv0.0.2 -
Update HTTPS Edge
actionUpdates an HTTPS Edge. See the documentation.Writev0.0.2
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.
- App slug
- ngrok
- Authentication
- API key
- Categories
- Developer Tools
- Actions
- 4
- Triggers
- 0
- API proxy
- Available