DevelopAPI
realtime-services
Every endpoint of realtime-services in this Release, with the permission each one needs
realtime-services pushes events over socket.io at the path /api/realtime. Send token or key in the query of the connection. The table lists the events you send to subscribe or unsubscribe. They are not HTTP requests.
| Method | Path | What it does | Needs |
|---|---|---|---|
| SUBSCRIBE | /item | Receive the events of an Item | An Item you can access |
| UNSUBSCRIBE | /item | Stop receiving the events of an Item | - |
| SUBSCRIBE | /item/database | Receive the events of the Record writes of a database | A database or a table you can access |
| UNSUBSCRIBE | /item/database | Stop receiving the events of the Record writes of a database | - |
| SUBSCRIBE | /role | Receive the events of roles | An administrator |
| UNSUBSCRIBE | /role | Stop receiving the events of roles | - |
| SUBSCRIBE | /task-manager | Receive the events of one of your background jobs | The owner of the job |
| UNSUBSCRIBE | /task-manager | Stop receiving the events of a background job | - |
| SUBSCRIBE | /user | Receive the events of users | An administrator |
| UNSUBSCRIBE | /user | Stop receiving the events of users | - |
This page is written from the code of this Release. Every endpoint needs a sign-in as described in Authentication, unless the Needs column says it does not.