Skip to content
handupbeta
Download

events

View as Markdown
GET
/v1/events

WebSocket events: {type, request} for request.created (carrying the final status, so auto-handled requests arrive already decided), request.decided, request.expired and request.cancelled; request.deleted (carrying the request as it was removed) after a request is deleted; request.updated when a pending request’s desktop run starts, a stop is requested, or its claim is released or interrupted (request.run); {type: yolo.changed, yolo} when YOLO mode changes or its timer ends; {type: auto_read.changed, at} when the shared auto-handled read watermark increases; {type: floods.changed, floods: [FloodSource]} when a source starts or stops flooding or its muted state changes; {type: mutes.changed, mutes: [Mute]} when a mute is added, removed or its timer ends; {type: keys.changed, keys} when the shortcut overrides change; {type: config.changed, config: ConfigChange} after every config save (file edit, handup config set, or a Settings save): applied keys are in force, restart_required keys wait for a daemon restart, and error (path:line: message) means the file is invalid and the previous config stays in force. Refetch /v1/ui-settings on it. Ignore unknown event types. Closed immediately when the calling device is revoked (4401) or disabled (4403). The daemon sends a WebSocket ping every 25 s, so a client that hears nothing for longer can treat the connection as dead