View as Markdown
Hex icon

Hex ACTION

List Data Connections

List all data connections. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Hex account once, then configure and run List Data Connections 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-list-data-connections",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hex: { authProvisionId: "apn_xxxxxxx" },
    sortBy: "Sort By",
    sortDirection: "Sort Direction",
  },
})

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.

List Data Connections inputs
Property Type Description
sortBy Sort By string
Sort the data connections by a field.
Optional
sortDirection Sort Direction string
The direction to sort the data connections.
Optional
maxResults Max Results integer
The maximum number of results to return.
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-list-data-connections
Version
0.0.1
App
Hex
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes