Something went wrong. Try again.
A lexicon-driven AppView for ATProto.
Something went wrong. Try again.
50 kB · 110 lines
HTML
at gh-pages
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110<!doctype html><html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-tutorials/statusphere" data-has-hydrated="false"><head><meta charset="UTF-8"><meta name="generator" content="Docusaurus v3.10.0"><title data-rh="true">Tutorial: Statusphere with HappyView | HappyView</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://happyview.dev/img/og.png"><meta data-rh="true" name="twitter:image" content="https://happyview.dev/img/og.png"><meta data-rh="true" property="og:url" content="https://happyview.dev/tutorials/statusphere"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Tutorial: Statusphere with HappyView | HappyView"><meta data-rh="true" name="description" content="Statusphere is an example atproto application where users set their current status as a single emoji. It's a great way to learn how HappyView works because the data model is simple but the queries are interesting."><meta data-rh="true" property="og:description" content="Statusphere is an example atproto application where users set their current status as a single emoji. It's a great way to learn how HappyView works because the data model is simple but the queries are interesting."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://happyview.dev/tutorials/statusphere"><link data-rh="true" rel="alternate" href="https://happyview.dev/tutorials/statusphere" hreflang="en"><link data-rh="true" rel="alternate" href="https://happyview.dev/tutorials/statusphere" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Statusphere","item":"https://happyview.dev/tutorials/statusphere"}]}</script><link rel="stylesheet" href="/assets/css/styles.18b9c377.css"><script src="/assets/js/runtime~main.413aac68.js" defer="defer"></script><script src="/assets/js/main.c991874c.js" defer="defer"></script></head><body><svg style="display: none;"><defs><symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol></defs></svg><script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/img/logo.light.png"><link rel="preload" as="image" href="/img/logo.dark.png"><div role="region" aria-label="Skip to main content"><a class="skipToContent_hn_G" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.light.png" alt="HappyView" class="themedComponent_EfZ_ themedComponent--light_EnZ3"><img src="/img/logo.dark.png" alt="HappyView" class="themedComponent_EfZ_ themedComponent--dark_UTRq"></div><b class="navbar__title text--truncate"></b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/">Docs</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/gamesgamesgamesgamesgames/happyview" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_yqny"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_pDN8 colorModeToggle_WR5U"><button class="clean-btn toggleButton__Co1 toggleButtonDisabled_pTNf" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_IF_c lightToggleIcon_z1QC"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_IF_c darkToggleIcon_O_bk"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_IF_c systemToggleIcon_SKeC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_qQFS"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_NcQk"><div class="docsWrapper_tjyD"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_J6bC" type="button"></button><div class="docRoot_mCS9"><aside class="theme-doc-sidebar-container docSidebarContainer_AIvH"><div class="sidebarViewport_v5_F"><div class="sidebar_TbVu"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_hz51"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/"><span title="Introduction" class="linkLabel_GBZK">Introduction</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/getting-started/quickstart"><span title="Getting Started" class="categoryLinkLabel_ppUb">Getting Started</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/tutorials/statusphere"><span title="Tutorials" class="categoryLinkLabel_ppUb">Tutorials</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tutorials/statusphere"><span title="Statusphere" class="linkLabel_GBZK">Statusphere</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/guides/lexicons"><span title="Guides" class="categoryLinkLabel_ppUb">Guides</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/sdk/overview"><span title="JavaScript SDK" class="categoryLinkLabel_ppUb">JavaScript SDK</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_RHuM menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/reference/xrpc-api"><span title="Reference" class="categoryLinkLabel_ppUb">Reference</span></a></div></li></ul></nav></div></div></aside><main class="docMainContainer_Gcuv"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_SLVn"><div class="docItemContainer_gUK8"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer__5rh" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_ilNI"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Tutorials</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Statusphere</span></li></ul></nav><div class="tocCollapsible_vaUl theme-doc-toc-mobile tocMobile_CcuZ"><button type="button" class="clean-btn tocCollapsibleButton__AHn">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Tutorial: Statusphere with HappyView</h1></header><p><a href="https://github.com/bluesky-social/statusphere-example-app" target="_blank" rel="noopener noreferrer" class="">Statusphere</a> is an example atproto application where users set their current status as a single emoji. It's a great way to learn how HappyView works because the data model is simple but the queries are interesting.</p><p>In this tutorial, you'll set up HappyView to act as the AppView for Statusphere. By the end, you'll have indexed records and working XRPC endpoints.</p><div class="theme-admonition theme-admonition-tip admonition_Dpr7 alert alert--success"><div class="admonitionHeading_d6Ef"><span class="admonitionIcon_epaQ"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent__5gi"><p>This tutorial assumes you have a running HappyView instance. If you don't, start with the <a class="" href="/getting-started/deployment/railway">Quickstart</a> or one of the local development guides (<a class="" href="/getting-started/deployment/docker">Docker</a>, <a class="" href="/getting-started/deployment/other">from source</a>).</p></div></div><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="the-statusphere-lexicon">The Statusphere lexicon<a href="#the-statusphere-lexicon" class="hash-link" aria-label="Direct link to The Statusphere lexicon" title="Direct link to The Statusphere lexicon" translate="no"></a></h2><p>Statusphere uses a single record type, <code>xyz.statusphere.status</code>. Each record has two fields:</p><ul><li class=""><code>status</code>: a single emoji</li><li class=""><code>createdAt</code>: a timestamp</li></ul><p>Users can set their status as many times as they want. Each status is a new record in their repository, keyed by a TID (timestamp-based identifier). The most recent record is their "current" status.</p><p>For more background on how the app works, see the <a href="https://atproto.com/guides/applications" target="_blank" rel="noopener noreferrer" class="">ATProto Statusphere guide</a>.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="step-1-add-the-record-lexicon">Step 1: Add the record lexicon<a href="#step-1-add-the-record-lexicon" class="hash-link" aria-label="Direct link to Step 1: Add the record lexicon" title="Direct link to Step 1: Add the record lexicon" translate="no"></a></h2><p>First, tell HappyView to start indexing Statusphere records. Since <code>xyz.statusphere.status</code> is <a class="" href="/guides/lexicons#network-lexicons">published on the atproto network</a>, you can add it directly from the dashboard:</p><ol><li class="">Go to <strong>Lexicons > Add Lexicon > Network</strong></li><li class="">Enter <code>xyz.statusphere.status</code></li><li class="">HappyView resolves the schema from its authority domain records and shows a preview</li><li class="">Enable the <strong>Backfill</strong> toggle so HappyView fetches existing records from the network</li><li class="">Click <strong>Add</strong></li></ol><p>HappyView now subscribes to <code>xyz.statusphere.status</code> via Jetstream and kicks off a backfill job to index historical records.</p><div class="theme-admonition theme-admonition-tip admonition_Dpr7 alert alert--success"><div class="admonitionHeading_d6Ef"><span class="admonitionIcon_epaQ"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent__5gi"><p>You can also add lexicons via the <a class="" href="/reference/admin/lexicons">admin API</a>. This is useful for automation or CI/CD workflows:</p><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl -X POST http://localhost:3000/admin/lexicons \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Authorization: Bearer $TOKEN" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Content-Type: application/json" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -d '{</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "lexicon_json": {</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "lexicon": 1,</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "id": "xyz.statusphere.status",</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "defs": {</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "main": {</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "type": "record",</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "key": "tid",</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "record": {</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "type": "object",</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "required": ["status", "createdAt"],</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "properties": {</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "status": { "type": "string", "maxGraphemes": 1 },</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "createdAt": { "type": "string", "format": "datetime" }</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> "backfill": true</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> }'</span><br></div></code></pre></div></div></div></div><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="step-2-verify-records-are-being-indexed">Step 2: Verify records are being indexed<a href="#step-2-verify-records-are-being-indexed" class="hash-link" aria-label="Direct link to Step 2: Verify records are being indexed" title="Direct link to Step 2: Verify records are being indexed" translate="no"></a></h2><p>Once the backfill starts, you should see records appearing in the dashboard:</p><ol><li class="">The <strong>home page</strong> shows a live record count and per-collection breakdown</li><li class="">Go to <strong>Records</strong> to browse individual indexed statuses</li><li class="">Go to <strong>Backfill</strong> to watch the backfill job progress — you'll see the number of repos processed and records fetched</li></ol><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="step-3-add-a-query-lexicon-for-listing-statuses">Step 3: Add a query lexicon for listing statuses<a href="#step-3-add-a-query-lexicon-for-listing-statuses" class="hash-link" aria-label="Direct link to Step 3: Add a query lexicon for listing statuses" title="Direct link to Step 3: Add a query lexicon for listing statuses" translate="no"></a></h2><p>Now add a query endpoint to read the indexed data:</p><ol><li class="">Go to <strong>Lexicons > Add Lexicon > Local</strong></li><li class="">Set the NSID to <code>xyz.statusphere.listStatuses</code></li><li class="">Set the type to <strong>Query</strong></li><li class="">Set <code>target_collection</code> to <code>xyz.statusphere.status</code> — this tells the query which record collection it operates on (<code>target_collection</code> is a HappyView-specific field, not part of the lexicon spec)</li><li class="">Click <strong>Add</strong></li></ol><p>This creates a <code>GET /xrpc/xyz.statusphere.listStatuses</code> endpoint. Without a Lua script, it uses HappyView's built-in default behavior: listing records with <code>limit</code>, <code>cursor</code>, and <code>did</code> parameters, or fetching a single record by <code>uri</code>. Try it:</p><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl "http://localhost:3000/xrpc/xyz.statusphere.listStatuses?limit=5" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "X-Client-Key: $CLIENT_KEY"</span><br></div></code></pre></div></div><div class="language-json codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-json codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"records"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"uri"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"at://did:plc:abc/xyz.statusphere.status/3abc123"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"status"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"\ud83d\ude0a"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"createdAt"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"2025-01-01T12:00:00Z"</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"uri"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"at://did:plc:def/xyz.statusphere.status/3def456"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"status"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"\ud83c\udf1f"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"createdAt"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"2025-01-01T11:30:00Z"</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"cursor"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"MjAyNS0wMS0wMVQxMjowMDowMFp8YXQ6Ly9kaWQ6..."</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br></div></code></pre></div></div><p>See <a class="" href="/reference/xrpc-api">XRPC API</a> for the full default query behavior.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="step-4-enhance-the-query-with-a-lua-script">Step 4: Enhance the query with a Lua script<a href="#step-4-enhance-the-query-with-a-lua-script" class="hash-link" aria-label="Direct link to Step 4: Enhance the query with a Lua script" title="Direct link to Step 4: Enhance the query with a Lua script" translate="no"></a></h2><p>The default query behavior works, but let's customize it with a <a class="" href="/guides/scripting">Lua script</a>. The script will handle single-record lookups by URI and paginated listing with an optional DID filter.</p><ol><li class="">Click on <strong>xyz.statusphere.listStatuses</strong> in the lexicon list to open its detail page</li><li class="">The Lua script editor is at the bottom of the page</li><li class="">Paste in the following script:</li></ol><div class="language-lua codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-lua codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token keyword" style="font-style:italic">function</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">handle</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token keyword" style="font-style:italic">if</span><span class="token plain"> params</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">uri </span><span class="token keyword" style="font-style:italic">then</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token keyword" style="font-style:italic">local</span><span class="token plain"> record </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> db</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token function" style="color:rgb(130, 170, 255)">get</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">params</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">uri</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token keyword" style="font-style:italic">if</span><span class="token plain"> </span><span class="token keyword" style="font-style:italic">not</span><span class="token plain"> record </span><span class="token keyword" style="font-style:italic">then</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token keyword" style="font-style:italic">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"> error </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"not found"</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token keyword" style="font-style:italic">end</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token keyword" style="font-style:italic">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"> record </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> record </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token keyword" style="font-style:italic">end</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token keyword" style="font-style:italic">return</span><span class="token plain"> db</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token function" style="color:rgb(130, 170, 255)">query</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> collection </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> collection</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> did </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> params</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">did</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> limit </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">tonumber</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">params</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">limit</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token keyword" style="font-style:italic">or</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">20</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> cursor </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> params</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">cursor</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token keyword" style="font-style:italic">end</span><br></div></code></pre></div></div><ol start="4"><li class="">Click <strong>Save</strong></li></ol><p>The endpoint now uses your custom logic. Filter by a specific user:</p><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl "http://localhost:3000/xrpc/xyz.statusphere.listStatuses?did=did:plc:abc&limit=1" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "X-Client-Key: $CLIENT_KEY"</span><br></div></code></pre></div></div><p>Fetch a single record by URI:</p><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl "http://localhost:3000/xrpc/xyz.statusphere.listStatuses?uri=at://did:plc:abc/xyz.statusphere.status/3abc123" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "X-Client-Key: $CLIENT_KEY"</span><br></div></code></pre></div></div><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="step-5-add-a-procedure-lexicon-for-setting-status">Step 5: Add a procedure lexicon for setting status<a href="#step-5-add-a-procedure-lexicon-for-setting-status" class="hash-link" aria-label="Direct link to Step 5: Add a procedure lexicon for setting status" title="Direct link to Step 5: Add a procedure lexicon for setting status" translate="no"></a></h2><p>Add a write endpoint so users can set their status through your AppView:</p><ol><li class="">Go to <strong>Lexicons > Add Lexicon > Local</strong></li><li class="">Set the NSID to <code>xyz.statusphere.setStatus</code></li><li class="">Set the type to <strong>Procedure</strong></li><li class="">Set <code>target_collection</code> to <code>xyz.statusphere.status</code></li><li class="">A default Lua script is generated — replace it with:</li></ol><div class="language-lua codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-lua codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token keyword" style="font-style:italic">function</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">handle</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token keyword" style="font-style:italic">local</span><span class="token plain"> r </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">Record</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">collection</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> status </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> input</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">status</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> createdAt </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">now</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> r</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token function" style="color:rgb(130, 170, 255)">save</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token keyword" style="font-style:italic">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"> uri </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> r</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">_uri</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> cid </span><span class="token operator" style="color:rgb(137, 221, 255)">=</span><span class="token plain"> r</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token plain">_cid </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token keyword" style="font-style:italic">end</span><br></div></code></pre></div></div><ol start="6"><li class="">Click <strong>Add</strong></li></ol><p>This creates a <code>POST /xrpc/xyz.statusphere.setStatus</code> endpoint that creates records on the user's PDS and indexes them locally.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="step-6-test-the-procedure-endpoint">Step 6: Test the procedure endpoint<a href="#step-6-test-the-procedure-endpoint" class="hash-link" aria-label="Direct link to Step 6: Test the procedure endpoint" title="Direct link to Step 6: Test the procedure endpoint" translate="no"></a></h2><p>Set a status. This requires DPoP authentication — the <a class="" href="/sdk/overview">JavaScript SDK</a> handles this for you, but you can test with curl if you have a token:</p><div class="language-sh codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-sh codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token plain">curl -X POST http://localhost:3000/xrpc/xyz.statusphere.setStatus \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "X-Client-Key: $CLIENT_KEY" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Authorization: DPoP $TOKEN" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "DPoP: $DPOP_PROOF" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -H "Content-Type: application/json" \</span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> -d '{ "status": "\ud83d\ude80" }'</span><br></div></code></pre></div></div><div class="language-json codeBlockContainer_ei_j theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_p9UO"><pre tabindex="0" class="prism-code language-json codeBlock_NBAy thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AQpN"><div class="token-line" style="color:#bfc7d5"><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"uri"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"at://did:plc:yourDID/xyz.statusphere.status/3xyz789"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"cid"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"bafyreiabc123..."</span><span class="token plain"></span><br></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><br></div></code></pre></div></div><p>The record is created on your PDS and immediately indexed by HappyView.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="what-youve-built">What you've built<a href="#what-youve-built" class="hash-link" aria-label="Direct link to What you've built" title="Direct link to What you've built" translate="no"></a></h2><p>With three lexicons and a few lines of Lua, you have a complete Statusphere AppView:</p><ul><li class=""><strong>Real-time indexing</strong> of <code>xyz.statusphere.status</code> records from the entire atproto network</li><li class=""><strong>Historical backfill</strong> of existing status records</li><li class=""><strong>A query endpoint</strong> (<code>xyz.statusphere.listStatuses</code>) with filtering, pagination, and single-record lookups</li><li class=""><strong>A write endpoint</strong> (<code>xyz.statusphere.setStatus</code>) that creates records on the user's PDS and indexes them locally</li></ul><p>Everything was done through the dashboard — no server restarts, no config files, no deploys. For automation and CI/CD, the same operations are available via the <a class="" href="/reference/admin-api">admin API</a>.</p><h2 class="anchor anchorTargetStickyNavbar_zGuS" id="next-steps">Next steps<a href="#next-steps" class="hash-link" aria-label="Direct link to Next steps" title="Direct link to Next steps" translate="no"></a></h2><ul><li class=""><a class="" href="/guides/scripting">Lua Scripting</a>: Explore the full Record and database APIs to build more complex queries</li><li class=""><a class="" href="/guides/lexicons">Lexicons</a>: Learn about network lexicons, the backfill flag, and target collections</li><li class=""><a class="" href="/reference/xrpc-api">XRPC API</a>: Understand how the generated endpoints behave</li><li class=""><a class="" href="/reference/admin-api">Admin API</a>: Automate lexicon management via the API</li><li class=""><a href="https://github.com/bluesky-social/statusphere-example-app" target="_blank" rel="noopener noreferrer" class="">Statusphere example app</a>: See the full Statusphere frontend</li><li class=""><a href="https://atproto.com/guides/applications" target="_blank" rel="noopener noreferrer" class="">ATProto Statusphere guide</a>: Deep dive into how the app works at the protocol level</li></ul></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/getting-started/dashboard"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Dashboard</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/guides/lexicons"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Lexicons</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_X45M thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#the-statusphere-lexicon" class="table-of-contents__link toc-highlight">The Statusphere lexicon</a></li><li><a href="#step-1-add-the-record-lexicon" class="table-of-contents__link toc-highlight">Step 1: Add the record lexicon</a></li><li><a href="#step-2-verify-records-are-being-indexed" class="table-of-contents__link toc-highlight">Step 2: Verify records are being indexed</a></li><li><a href="#step-3-add-a-query-lexicon-for-listing-statuses" class="table-of-contents__link toc-highlight">Step 3: Add a query lexicon for listing statuses</a></li><li><a href="#step-4-enhance-the-query-with-a-lua-script" class="table-of-contents__link toc-highlight">Step 4: Enhance the query with a Lua script</a></li><li><a href="#step-5-add-a-procedure-lexicon-for-setting-status" class="table-of-contents__link toc-highlight">Step 5: Add a procedure lexicon for setting status</a></li><li><a href="#step-6-test-the-procedure-endpoint" class="table-of-contents__link toc-highlight">Step 6: Test the procedure endpoint</a></li><li><a href="#what-youve-built" class="table-of-contents__link toc-highlight">What you've built</a></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 <a href="https://birb.house">Birbhouse Games</a>.</div></div></div></footer></div></body></html>