Skip to main content
Layarva currently exposes a bounded API surface for Queue operations, Structured Widget snapshots, and prayer-schedule data ingestion.

Queue API

Read Queue services and state, issue tickets, and read a ticket using a Queue-scoped credential.

Prayer schedule Push

Push complete monthly prayer schedules using a workspace-scoped credential.

Structured Widget Push

Replace supported Widget snapshots without republishing the Design.

Widget WebSocket protocol

Stream compatible runtime envelopes from a relay that you operate.

Queue webhooks

Receive signed ticket-completed and ticket-no-show events from Layarva.
Layarva does not currently provide a general public REST API for Workspaces, Screens, Content, Playlists, Publications, or Campaigns. Those dashboard operations use internal server actions and must not be treated as customer APIs.

Authentication boundaries

  • Queue API credentials are scoped to a Queue Unit and authorized Queue operations.
  • Workspace API keys authorize the supported prayer-schedule and Structured Widget Push APIs.
  • Secure WebSocket is a Player-to-relay protocol. It does not use the Workspace API Key and does not expose a Layarva-hosted WebSocket broker.
Custom HTML/JavaScript Widget guides remain excluded. Structured built-in Widgets use a separate, supported data contract documented here.

Start here