View as Markdown
Streamlabs icon

Streamlabs ACTION

Send Alert

Sends an alert to the stream overlay with a custom message, image, and sound. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Streamlabs account once, then configure and run Send Alert 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: "streamlabs-send-alert",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    streamlabs: { authProvisionId: "apn_xxxxxxx" },
    type: "Type",
    message: "Message",
  },
})

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 Alert inputs
Property Type Description
type Type string
determines which alert box this alert will show up in
Required
message Message string
The message to show with this alert
Required
imageHref Image HREF string
The href pointing to an image resource to play when this alert shows
Optional
soundHref Sound HREF string
The href pointing to a sound resource to play when this alert shows
Optional
userMessage User Message string
Acting as the second heading, this shows below message
Optional
duration Duration string
How many seconds this alert should be displayed. Value should be in milliseconds. Ex: 1000 for 1 second.
Optional
specialTextColor Special Text Color string
The color to use for special tokens. Must be a valid CSS color string
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
streamlabs-send-alert
Version
0.0.2
App
Streamlabs
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes