Box TRIGGER
New File Event
FILE.UPLOADED), via a Box webhook. Box fires this trigger for both cases, so moving an existing file into the folder also emits an event. See the documentation- Trigger
- Instant
- OAuth
- Webhook delivery
IMPLEMENTATION
Deploy this event source
Connect the user's Box account, configure the source, and choose the webhook where your backend receives events.
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 deployed = await pd.triggers.deploy({
id: "box-new-file",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
box: { authProvisionId: "apn_xxxxxxx" },
webhookTarget: "Target",
includeLink: true,
},
webhookUrl: "https://example.com/webhooks/box",
})
console.log(deployed.id)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/triggers/deploy \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "box-new-file",
"webhook_url": "https://example.com/webhooks/box",
"configured_props": {
"box": { "authProvisionId": "apn_xxxxxxx" },
"webhookTarget": "Target",
"includeLink": true
}
}'MCP servers expose Box actions as on-demand tools.
New File Event is an event source, so your application deploys it
with the Connect SDK or API and then either receives each event at a
webhook URL or retrieves events on demand with the trigger events API.MCP exposes on-demand actions. Event sources are deployed through the Connect SDK or API because they continue listening after the initial request.
SCHEMA
Configuration
These inputs define which events the source watches. Dynamic options are loaded from the connected account.
| Property | Type | Description |
|---|---|---|
webhookTarget Target | string | The target item that will be used by webhooks. Required Dynamic |
includeLink Include Link | boolean | Upload file to your File Stash and emit temporary download link to the file. See the docs to learn more about working with files in Pipedream. Optional |
dir Dir | dir | Optional |
LIFECYCLE
Event delivery
01
Connect
Your user authorizes Box through Pipedream managed auth.
02
Deploy
Your backend deploys this source with that user's own configuration.
03
Webhook delivery
Every event is sent to the HTTP endpoint you choose when you deploy the source — as it happens.
OR
On-demand retrieval
No webhook required. Your app or agent can fetch recent events from the trigger events API.
REFERENCE
Trigger details
- Registry key
- box-new-file
- Version
- 0.1.5
- App
- Box
- Authentication
- OAuth
- Delivery
- Instant event
- Output
- Events emitted by Box.
- Source
- View on GitHub ↗