Bonusly ACTION
Give Bonus
Send recognition (a bonus) to one or more colleagues on behalf of the authenticated caller. Do not include
@mentions or the point amount in the reason yourself - Bonusly synthesizes those from recipients and amount automatically. See the documentation- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Bonusly account once, then configure and run Give Bonus 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: "bonusly-give-bonus",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
bonusly: { authProvisionId: "apn_xxxxxxx" },
recipients: ["Recipients"],
amount: 10,
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "bonusly-give-bonus",
"configured_props": {
"bonusly": { "authProvisionId": "apn_xxxxxxx" },
"recipients": ["Recipients"],
"amount": 10
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "bonusly",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "bonusly-give-bonus",
arguments: {
recipients: ["Recipients"],
amount: 10,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
recipients Recipients | string[] | One or more recipients - each entry can be a user ID, an email address, or a display name, e.g. john.smith@company.com. Use Search Users to look up one person by name, or List Users In Department, List Users In Location, or List Top-Level Users to recognize a whole roster at once. Required |
amount Amount | integer | Points to give. Pass 0 only if your company allows zero-point recognition. Required |
reason Reason | string | Free-form recognition message explaining why you're giving this bonus, e.g. Great work on the product launch!. Required |
hashtag Hashtag | string | One company hashtag, without the leading #, e.g. teamwork. Some Bonusly companies require a hashtag on every recognition - if the tool rejects the request for a missing hashtag, set one here. 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
- bonusly-give-bonus
- Version
- 0.0.2
- App
- Bonusly
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗