---
title: "Connect to tool output stream (WebSocket)"
method: GET
path: "/v1/object-tools/output/{token}"
tags: ["Object Tools"]
---

# Connect to tool output stream (WebSocket)

`GET /v1/object-tools/output/{token}`

WebSocket endpoint for receiving streaming output from an object tool execution.
The token is obtained from POST /v1/object-tools/{tool-id}/execute with stream=true.
Token is single-use and expires after 30 seconds.

Server sends JSON text frames:
- `{"type":"output","data":"..."}` - output chunk
- `{"type":"result","data":"..."}` - script return value (server-script tools only)
- `{"type":"completed"}` - execution finished successfully
- `{"type":"error","message":"..."}` - execution failed

## Path parameters

- `token` string, uuid, required

## Other responses

- `101` — Switching protocols to WebSocket

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/14d93e5115dd/schema)