Skip to content

Guides

A guide takes you step by step to a working result. The REST guides use curl. The REST reference documents every endpoint. A guide tells you which ones to call, in which order, and what to keep from each answer.

GuideWhat it covers
Score a match from your systemCreate a match, post the facts as the match runs, and close it
Automate a streamPreview, go live, switch the overlay, stop publishing, and stop
Configure a streamCreate an input, save a destination, create the stream of a match and link them
Receive webhooksStand up an endpoint, verify the signature, answer fast, and read the delivery log
Publish a theme versionRead the theme, pin graphic versions, publish, and activate. Beta
Give each competition its own coloursSet a colour theme variable per competition theme profile and read it in a Rive expression. Beta
Manage image templatesCreate fixed-size image slots, set a default image, set entity images, and delete a template
Build a game planCreate a game plan, add a playlist and a trigger, duplicate the plan, and read the copy. Beta
Make clipsSet a highlight rule per event, turn on stream highlights, and mark a manual moment with its own clip. Beta
Build a code graphicFrom one HTML file to a graphic on an overlay. In the Graphics SDK section. Beta
Import a Rive graphicFrom a source project to a native preset on an overlay. Beta

The REST guides use a write key and https://api.ligr.live/rest. Set LIGR_API_KEY in your shell before you start. See Your first request if you have no key yet.

Two shorter tasks have their own reference pages.