Skip to main content
End the event when the show is over. This marks the session as ENDED on the backend, stops new attendees from joining, and finalizes any usage tracking.

Endpoint

POST /api/v1/runtime/events/{eventId}/end/client
Auth: Authorization: Bearer <accessToken> (your runtime client token)
Path paramDescription
eventIdThe event ID returned by Start Event
No request body required.

Response

{
  "eventId": "evt_xxxxxxxxxxxxxxxx",
  "status": "ENDED"
}

Error responses

StatusCodeMeaning
401INVALID_RUNTIME_CLIENTToken missing or invalid
403EVENT_NOT_AUTHORIZED_OR_NOT_FOUNDEvent not found, already ended, or this token isn’t authorized to end it

When to call it

Call end-event when the operator signals the show is over — typically on a “Stop Show” button press, on Event EndPlay, or when a specific game show state is reached (e.g. scoreboard displayed).
Operator presses "End Show"

HTTP POST /runtime/events/{eventId}/end/client

Session marked ENDED — audience can no longer join

Clean up local state (clear eventId variable)
Always end events explicitly. Abandoned sessions (e.g. from a crash) will eventually time out on the backend, but calling end proactively ensures clean analytics and prevents the session from counting against your concurrency limit.

Ending from the dashboard

If your visual crashes before it can call this endpoint, you can manually end the event from the xRLive dashboard under Creator → Runtime Clients → Active Events.