View as Markdown
Hex icon

Hex ACTION

Edit Data Connection

Edit a specific 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 Edit 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-edit-data-connection",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hex: { authProvisionId: "apn_xxxxxxx" },
    connectionId: "Connection ID",
    sharingWorkspacePublic: "Sharing Workspace Public",
  },
})

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.

Edit Data Connection inputs
Property Type Description
connectionId Connection ID string
The ID of the connection to update.
Required Dynamic
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" }}
Optional
name Name string
The name of the data connection.
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
hex-edit-data-connection
Version
0.0.1
App
Hex
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes