Hex ACTION
Create Data Connection
Create a data connection. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Hex account once, then configure and run Create Data 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: "hex-create-data-connection",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
hex: { authProvisionId: "apn_xxxxxxx" },
sharingWorkspacePublic: "Sharing Workspace Public",
sharingWorkspaceGuests: "Sharing Workspace Guests",
},
})
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": "hex-create-data-connection",
"configured_props": {
"hex": { "authProvisionId": "apn_xxxxxxx" },
"sharingWorkspacePublic": "Sharing Workspace Public",
"sharingWorkspaceGuests": "Sharing Workspace Guests"
}
}'// 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": "hex",
},
},
},
)
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: "hex-create-data-connection",
arguments: {
sharingWorkspacePublic: "Sharing Workspace Public",
sharingWorkspaceGuests: "Sharing Workspace Guests",
},
})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 |
|---|---|---|
sharingWorkspacePublic Sharing Workspace Public | string | Data connection public sharing access level. Optional |
sharingWorkspaceGuests Sharing Workspace Guests | string | Data connection guests sharing access level. Optional |
sharingWorkspaceMembers Sharing Workspace Members | string | Data connection members sharing access level. Optional |
schemaRefreshAccess Schema Refresh Access | string | Schema refresh access level. Optional |
schemaRefreshSchedule Schema Refresh Schedule | object | An object with the schema refresh schedule data. See the documentation for more information. E.g. { "cadence": "DAILY", "enabled": true, "daily": {"timezoneString": "America/New_York", "hour": 12, "minute": 0 } } Optional |
schemaFilters Schema Filters | object | An object with the schema filters data. See the documentation for more information. E.g. { "tables": {"exclude": {"values": ["table1", "table2"], "matchType": "EXACT"}}, "schemas": {"include": {"values": ["schema1", "schema2"], "matchType": "PREFIX"}}} Optional |
allowWritebackCells Allow Writeback Cells | boolean | Allow writeback cells. Optional |
includeMagic Include Magic | boolean | Include magic. Optional |
connectViaSsh Connect Via SSH | boolean | Connect via SSH. Optional |
description Description | string | The description of the data connection. Optional |
connectionDetails Connection Details | object | An object with the connection details data. See the documentation for more information. E.g. { "bigquery": { "serviceAccountJsonConfig": "string", "enableStorageApi": true, "enableDriveAccess": true, "projectId": "string" }} Required |
type Type | string | The type of the data connection. Required |
name Name | string | The name of the data connection. Required |
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
- hex-create-data-connection
- Version
- 0.0.1
- App
- Hex
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗