View as Markdown
Mural icon

Mural ACTION

Invite to Mural

Share a mural by inviting a user to it. Supply either Email or Username: an email invitation must be accepted by the recipient before they gain access, while inviting by username adds the user to the mural immediately. Users invited to a mural without being members of its room become restricted members, meaning they can open only that mural and cannot create murals in the room. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mural account once, then configure and run Invite to Mural 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-invite-to-mural",
  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.

Invite to Mural 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
email Email string
The email address of the user to invite
Optional
username Username string
The username of the user to invite. When inviting by username, the user is immediately added to the mural.
Optional
editPermission Edit Permission string
The level of access granted to the invited user. Use edit (the default) to let them add and change widgets, as you would for a collaborator contributing to a workshop. Use view for read-only access, as you would when sharing results with a stakeholder who should not alter the mural.
Required
message Message string
The custom message to be sent in the email invitation
Optional
sendEmail Send Email boolean
Indicates if the invitation will or will not be emailed. Default value is true.
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-invite-to-mural
Version
0.0.2
App
Mural
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes