View as Markdown
Element icon

Element ACTION

Invite User

Invite a user to an existing room. The connected account must already be joined to the room and have permission to invite. Optionally include a Reason, which is stored on the membership event. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Element account once, then configure and run Invite User 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: "element-invite-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    element: { authProvisionId: "apn_xxxxxxx" },
    roomId: "Room ID",
    userId: "User 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 User inputs
Property Type Description
roomId Room ID string
The Matrix room ID, e.g. !OGEhHVWSdvArJzumhm:matrix.org. Use List Rooms to find the ID of a room you've already joined, or Resolve Room Alias to convert an alias such as #engineering:matrix.org into an ID. Aliases are not accepted here.
Required
userId User ID string
The full Matrix ID of the user to invite, e.g. @alice:matrix.org. Note that some homeservers accept invites for user IDs that are not registered yet, so a successful response does not confirm the user exists.
Required
reason Reason string
Optional reason included on the membership event sent to the invitee, e.g. Welcome to the team!.
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
element-invite-user
Version
0.0.2
App
Element
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes