View as Markdown
Roblox icon

Roblox ACTION

Send User Notification

Send an experience notification to a Roblox user. Requires a notification string created in the Creator Dashboard. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Roblox account once, then configure and run Send User Notification 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: "roblox-send-user-notification",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    roblox: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
    universeId: "Universe 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.

Send User Notification inputs
Property Type Description
userId User ID string
The ID of the Roblox user to notify.
Required
universeId Universe ID string
The ID of the universe (experience) the notification is sent from.
Required
messageId Notification String ID string
The ID of the notification string (message template) to send, created in the Creator Dashboard.
Required
parameters Parameters object
A map of parameters used to render placeholders in the notification string template. Each value must be an object with a stringValue. For example, given a template Your {egg_name} just hatched., pass { "egg_name": { "stringValue": "royal egg" } }.
Optional
launchData Launch Data string
Arbitrary data made available to the experience when the user joins from the notification (max 200 bytes).
Optional
analyticsCategory Analytics Category string
Category of the notification, used to group analytics data (e.g. Bronze egg hatched).
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
roblox-send-user-notification
Version
0.0.2
App
Roblox
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes