Skip to content

Commit

Permalink
docs: add wait note
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin-Frost committed May 19, 2024
1 parent 2d0c0e2 commit 3b8fd5f
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ The API provides an endpoint to subscribe to events.

This endpoint uses HTTP Long Polling, meaning the connection will remain open until an event is available. Clients should make a request to this endpoint and wait for a response. Once a response is received, the client should immediately make another request to continue receiving events.

!!! note

For the initial request, it is possible to pass the query parameter `wait=false` to get the current event immediately.
> Note: For the initial request, it is possible to pass the query parameter `?wait=false` to get the current event immediately.
```
GET /events/:id/subscribe
Expand Down

0 comments on commit 3b8fd5f

Please sign in to comment.