Skip to content

Commit 6a90a52

Browse files
committed
Add note about streaming error responses
1 parent 701fd40 commit 6a90a52

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

content/en/methods/streaming.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -687,6 +687,25 @@ An example filter change by the user:
687687
Note that the `payload` property is not present for `filters_changed` events. And for `delete` and `announcements.delete` the payload is a string, not an object.
688688
{{</hint>}}
689689

690+
## Error responses
691+
692+
For HTTP requests to a non-existent streaming endpoint, the streaming server will respond with an HTTP 400 and a JSON body describing the error:
693+
694+
```json
695+
{
696+
"error": "Unknown channel requested"
697+
}
698+
```
699+
700+
For invalid requests within the WebSocket (for example, an incorrect stream name), the server will respond with error JSON:
701+
702+
```json
703+
{
704+
"error": "Unknown stream type",
705+
"status":400
706+
}
707+
```
708+
690709
## See also
691710

692711
### Streaming server

0 commit comments

Comments
 (0)