View as Markdown
Hookdeck icon

Hookdeck ACTION

Create Connection

This endpoint creates a connection. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Hookdeck account once, then configure and run Create Connection 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: "hookdeck-create-connection",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hookdeck: { authProvisionId: "apn_xxxxxxx" },
    name: "Connection Name",
    description: "Description",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Connection inputs
Property Type Description
name Connection Name string
The name of the connection.
Required
description Description string
The description of the connection.
Optional
source Source object
An object representing the source of the connection. Object must contain at least name. Please check the documentation for more information.
Optional
destination Destination object
An object representing the destination of the connection. Object must contain at least name and url. Please check the documentation for more information.
Optional
sourceId Source ID string
The source ID of the connection.
Optional Dynamic
destinationId Destination ID string
The destination ID of the connection.
Optional Dynamic

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
hookdeck-create-connection
Version
0.0.3
App
Hookdeck
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes