Open device wake WebSocket

Interactive OpenAPI clients cannot establish this WebSocket upgrade. Offer subprotocols openlaunch.device-events.v1 and ticket.<one-use-ticket>; the ticket expires after 30 seconds and is consumed once. Do not send a bearer header or put the secret ticket in a URL query. The channel carries no action payload.

GET/v1/device/{deviceId}/events

Authorization

Sec-WebSocket-ProtocolAPI key · headerrequired

Offer openlaunch.device-events.v1, ticket.<one-use ticket>. The ticket comes from the authenticated events-ticket endpoint, expires in 30 seconds, and is never a URL query parameter.

Path parameters

deviceIdstring<uuid>required

Query parameters

workspacestringrequired

Public workspace routing identifier; not a credential.

matches ^[a-f0-9]{64}$

Header parameters

x-openlaunch-workspacestringrequired

Workspace routing identifier for the device credential; not a secret. Must match the workspace query parameter.

matches ^[a-f0-9]{64}$

Responses

101

WebSocket upgrade. Sends payload-free work hints; read actions and report outcomes over HTTPS.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

deviceIdpath*workspacequery*Public workspace routing identifier; not a credential.x-openlaunch-workspaceheader*Workspace routing identifier for the device credential; not a secret. Must match the workspace query parameter.

Request

curl -X GET 'https://www.openlaunch.dev/v1/device/497f6eca-6276-4993-bfeb-53cbbbba6f08/events?workspace=string' \
  -H 'Sec-WebSocket-Protocol: YOUR_API_KEY' \
  -H 'x-openlaunch-workspace: string'

const response: Response = await fetch("https://www.openlaunch.dev/v1/device/497f6eca-6276-4993-bfeb-53cbbbba6f08/events?workspace=string", {
  method: "GET",
  headers: {
    "Sec-WebSocket-Protocol": "YOUR_API_KEY",
    "x-openlaunch-workspace": "string"
  }
});

import requests

response = requests.get(
    "https://www.openlaunch.dev/v1/device/497f6eca-6276-4993-bfeb-53cbbbba6f08/events?workspace=string",
    headers={
        "Sec-WebSocket-Protocol": "YOUR_API_KEY",
        "x-openlaunch-workspace": "string"
    },
)

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://www.openlaunch.dev/v1/device/497f6eca-6276-4993-bfeb-53cbbbba6f08/events?workspace=string", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Sec-WebSocket-Protocol", "YOUR_API_KEY")
	req.Header.Set("x-openlaunch-workspace", "string")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

Response

WebSocket upgrade. Sends payload-free work hints; read actions and report outcomes over HTTPS.