CodeQR ACTION
Create a CodeQR Link
Creates a short link in CodeQR using the CodeQR API. See the documentation
- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's CodeQR account once, then configure and run Create a CodeQR Link from your backend or agent.
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: "codeqr-create-link",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
codeqr: { authProvisionId: "apn_xxxxxxx" },
url: "URL",
key: "Key",
},
})
console.log(result)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": "codeqr-create-link",
"configured_props": {
"codeqr": { "authProvisionId": "apn_xxxxxxx" },
"url": "URL",
"key": "Key"
}
}'// 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": "codeqr",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "codeqr-create-link",
arguments: {
url: "URL",
key: "Key",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
url URL | string | The destination URL of the short link. Required |
key Key | string | The short link slug. If not provided, a random 7-character slug will be generated. Optional |
domain Domain | string | The domain of the short link. If not provided, the default workspace domain will be used. Optional |
externalId External ID | string | This is the ID of the link in your database. Must be prefixed with ext_. Optional |
password Password | string | The password required to access the destination URL. Optional |
flexible Flexible Link | boolean | Whether this is a flexible link with dynamic destination setting. Optional |
title Title | string | The title displayed on the short link page. Optional |
description Description | string | A description displayed on the short link page. Optional |
image Image URL | string | URL of the image displayed on the short link page. Optional |
video Video URL | string | URL of the video displayed on the short link page. Optional |
proxy Proxy | boolean | Enable proxy settings. Optional |
rewrite Rewrite Link | boolean | Enable link rewriting. Optional |
ios iOS URL | string | The iOS destination URL for device-specific redirection. Optional |
android Android URL | string | The Android destination URL for device-specific redirection. Optional |
doIndex Allow Indexing | boolean | Enable indexing of the short link. Optional |
comments Comments | string | Comments or notes about the short link. Optional |
expiresAt Expiration Date | string | The date and time when the short link will expire (ISO 8601). E.g. 2025-06-13T05:31:56Z Optional |
expiredUrl Expired Redirect URL | string | The URL to redirect to when the short link has expired. Optional |
geo Geo-Targeting | object | Mapping of country codes to destination URLs (JSON format). Optional |
publicStats Public Stats | boolean | Whether the short link's stats are publicly accessible. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- codeqr-create-link
- Version
- 0.0.3
- App
- CodeQR
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗