CONNECT APP
Build with Linkly
Easily create tracking links, add retargeting tags, do smart redirects and more.
Web & App Development
- API key
MCP
Give your agent Linkly tools
Every Linkly 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 Linkly 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": "linkly",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Link:
const result = await mcp.callTool({
name: "linkly-create-link",
arguments: {
url: "URL",
name: "Name",
},
})# 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": "linkly",
}
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 Link:
result = await session.call_tool("linkly-create-link", {
"url": "URL",
"name": "Name",
})API PROXY
Call the Linkly API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Linkly 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.example.com/v1/me",
})
// Any allowed Linkly 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.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Linkly actions from your backend
Connect a user's Linkly account once, then run Create Link 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: "linkly-create-link",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
linkly: { authProvisionId: "apn_xxxxxxx" },
url: "URL",
name: "Name",
},
})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="linkly-create-link",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"linkly": {"authProvisionId": "apn_xxxxxxx"},
"url": "URL",
"name": "Name",
},
)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": "linkly-create-link",
"configured_props": {
"linkly": { "authProvisionId": "apn_xxxxxxx" },
"url": "URL",
"name": "Name"
}
}'TOOLS
Linkly actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Link
actionCreate a new short link viaPOST /api/v1/link. See the documentation.Writev0.1.0 -
Delete Link
actionPermanently delete a short link viaDELETE /api/v1/workspace/{workspace_id}/links/{id}. The short URL will return 404 for new visitors. See the documentation.Writev0.0.1 -
Get Link
actionFetch a single short link viaGET /api/v1/link/{id}, with full metadata including click counts, custom domain, and redirect rules. See the documentation.Read-onlyv0.0.3 -
List Domains
actionList all custom domains in your workspace viaGET /api/v1/workspace/{workspace_id}/domains. See the documentation.Read-onlyv0.0.1 -
List Link ID Options
actionRetrieves available options for the Link ID field.Read-onlyv0.0.1 -
List Links
actionList all short links in your workspace viaGET /api/v1/workspace/{workspace_id}/list_links, with click counts and metadata. See the documentation.Read-onlyv0.0.1 -
List Workspaces
actionList all workspaces the API key has access to viaGET /api/v1/workspaces. Useful for finding the workspace ID required for API requests. See the documentation.Read-onlyv0.0.1 -
Update Link
actionUpdate an existing short link viaPOST /api/v1/link(withid) — change its destination URL, slug, name, or custom domain without breaking the existing short URL. See the documentation.Writev0.0.2
-
New Link Clicked (Instant)
triggerEmit new event each time any link in the workspace is clicked, with full click metadata (location, device, browser, referrer). Subscribes to a workspace webhook viaPOST /api/v1/workspace/{workspace_id}/webhooksfor real-time delivery. Note: webhooks require a paid Linkly plan. See the documentation.Instantv0.1.0 -
New Link Created
triggerEmit new event when a new link is created in the workspace. PollsGET /api/v1/workspace/{workspace_id}/list_linkssorted byinserted_atand emits anything newer than the last seen link ID. Useful for syncing newly-created short links to a CRM, spreadsheet, or analytics destination. See the documentation.v0.0.1
- App slug
- linkly
- Authentication
- API key
- Categories
- Web & App Development
- Actions
- 8
- Triggers
- 2
- API proxy
- Available