View as Markdown
Mural icon

Mural ACTION

List Widgets

List widgets in a mural. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mural account once, then configure and run List Widgets 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: "mural-list-widgets",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mural: { authProvisionId: "apn_xxxxxxx" },
    workspaceId: "Workspace ID",
    muralId: "Mural ID",
  },
})

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 Widgets inputs
Property Type Description
workspaceId Workspace ID string
The ID of the Workspace.
Required Dynamic
muralId Mural ID string
The ID of the Mural.
Required Dynamic
type Widget Types string[]
Filter by widget types, passed as an array such as ["sticky notes", "images"]. When not specified, returns all widget types.
Optional
parentId Parent ID string
Return only widgets contained in this area. Must be the id of an area widget, as returned by this action when filtering on the areas type
Optional Dynamic
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
mural-list-widgets
Version
0.0.1
App
Mural
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes