Class ReadyChecksResource

Ready Check template and session management.

Ready Checks are short-lived (20s) attendance polls that target connected operators. Templates define reusable configurations; sessions are live instances.

Example

// List configured templates
const { readyChecks } = await client.readyChecks.list();

// Create a template
const { readyCheck } = await client.readyChecks.upsert({
  message: "Fleet departing in 2 minutes — confirm ready",
  target: { everyone: true },
});

// Start a session from a template
const { session, summary } = await client.readyChecks.start(readyCheck.id, "Fleet Commander");

// Check session status
const status = await client.readyChecks.getSession(session.id);
console.log(status.summary.ready, "/", status.summary.total);

Constructors

constructor

Methods

getSession getSessions list remove start upsert

Constructors

constructor

Methods

getSession

getSessions

list

remove

start

  • start(
        templateId: string,
        initiatorName?: string,
    ): Promise<ReadyCheckStartResponse>

    Start a ready check session from a saved template. Requires write:ready-checks scope. Targets connected operators matching the template's audience and expires after ~20 seconds.

    Parameters

    • templateId: string

      ID of the template to initiate.

    • OptionalinitiatorName: string

      Display name of the person starting the check (shown to participants).

    Returns Promise<ReadyCheckStartResponse>

upsert

Settings

Member Visibility

On This Page

Constructors
Methods