View as Markdown
BippyBox icon

BippyBox ACTION

Activate Box

Triggers the BippyBox to play an audio file. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's BippyBox account once, then configure and run Activate Box 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: "bippybox-activate-box",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bippybox: { authProvisionId: "apn_xxxxxxx" },
    device: "Device",
    url: "URL",
  },
})

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.

Activate Box inputs
Property Type Description
device Device string
The device identifier. Eg. DEVICE123.
Required
url URL string
The URL of the audio file to play. Eg. https://storage.example.com/users/exampleUserUID67890/audio/SampleAudioFile.wav?alt=media&token=exampleToken123456.
Required

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
bippybox-activate-box
Version
0.0.3
App
BippyBox
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes