Events

Pincer streams real-time status notifications to all connected WebSocket clients. You do not need to poll for updates.

Previous: Advanced Features · Next: System Controls

Event Reference

Event	Scenario
`pin.onDownloadStart`	Triggered when a task enters active state.
`pin.onDownloadPause`	Triggered when a task is manually paused.
`pin.onDownloadComplete`	Triggered when a task finishes successfully.
`pin.onDownloadError`	Triggered when a task fails.
`pin.onDownloadStop`	Triggered when a task is stopped.
`pin.onBtDownloadComplete`	Triggered when a BitTorrent download completes.

All events follow the standard JSON-RPC 2.0 notification format (no id field):

{
  "jsonrpc": "2.0",
  "method": "pin.onDownloadComplete",
  "params": [{"gid": "2089b05ecca3d829"}]
}

The params array contains a single object with the gid (task ID) that triggered the event.