> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comforthub.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Names

> What we call each thing, and what Zoho and Supabase call it. The only page where code names are allowed

Use the first column everywhere in the handbook. The other columns exist so you can find the record when you are inside a tool. This is the one page the check allows code names on.

| We say                            | In Zoho                                 | In Supabase                                             |
| --------------------------------- | --------------------------------------- | ------------------------------------------------------- |
| customer                          | Contacts                                | core.customers                                          |
| account                           | Accounts                                | core.accounts                                           |
| lead                              | Leads                                   | sales.leads                                             |
| property                          | Properties                              | core.properties                                         |
| equipment, asset                  | Assets                                  | core.assets                                             |
| product                           | Products                                | catalog.items                                           |
| stock material                    | Stock\_Materials                        | catalog.materials                                       |
| supplier                          | Vendors                                 | catalog.suppliers                                       |
| purchase order                    | Supplier\_Orders                        | operations.purchase\_orders                             |
| work order                        | Work\_Orders                            | operations.workorders                                   |
| line item                         | Work\_Order\_Items (a subform)          | operations.workorder\_line\_items                       |
| appointment                       | Service\_Appointments                   | operations.service\_appointments                        |
| territory                         | Service\_Territories                    | scheduling.territories                                  |
| technician                        | Technicians                             | scheduling.technicians                                  |
| phone agent                       | Agents                                  | communication.agents                                    |
| invoice                           | Invoices                                | billing.invoices                                        |
| payment                           | Payments                                | billing.payment\_transactions                           |
| subscription                      | Subscriptions                           | billing.subscriptions                                   |
| subscription payment              | Subscription\_Payments                  | billing.subscription\_payments                          |
| checklist template                | Checklist\_Templates                    | checklists.templates                                    |
| assigned checklist                | Assigned\_Checklists                    | checklists.crm\_assigned\_checklists                    |
| checklist submission              | Checklist\_Submissions                  | checklists.assigned\_checklists                         |
| timesheet                         | Timesheets                              | app.timesheets                                          |
| time off request                  | Time\_Off\_Requests                     | app.time\_off\_requests                                 |
| payroll calendar                  | Payroll                                 | payroll.schedules, payroll.pay\_periods                 |
| call                              | Call\_History                           | communication.calls                                     |
| email                             | Email\_Tracking                         | communication.email\_messages                           |
| record lock                       | Record\_Lock\_History                   | communication.record\_locks                             |
| quote                             | (not in Zoho)                           | operations.work\_order\_quotes                          |
| stock list                        | (not in Zoho)                           | app.stock\_lists                                        |
| task, note                        | (not in Zoho)                           | operations.tasks, app.notes                             |
| app user                          | (not in Zoho)                           | app.users                                               |
| QuickBooks id                     | QBO Id, on the customer and the product | integrations.external\_ids, system qbo                  |
| covered items                     | Covered Items on the subscription       | billing.subscription\_covered\_items                    |
| subscription visit                | Subscription Visits on the subscription | (kept in the CRM; the engine sweeps it)                 |
| checklist question                | Checklist Questions on the template     | checklists.template\_steps                              |
| completion note template          | (not in Zoho)                           | app.completion\_note\_templates                         |
| stocking order                    | (not in Zoho)                           | catalog.stocking\_orders                                |
| supplier branch                   | a subform on the vendor                 | catalog.supplier\_branches                              |
| pay period                        | Payroll, Schedule                       | payroll.pay\_periods                                    |
| statutory holiday                 | Payroll, Holidays                       | payroll.statutory\_holidays                             |
| department                        | (not in Zoho)                           | communication.departments                               |
| phone line, its members           | (not in Zoho)                           | communication.phone\_lines, communication.line\_members |
| phone settings, the closed switch | (not in Zoho)                           | communication.phone\_settings                           |
| callback request                  | (not in Zoho)                           | communication.callback\_requests                        |
| voicemail                         | (not in Zoho)                           | communication.voicemails                                |
| text conversation                 | (not in Zoho)                           | communication.sms\_conversations                        |
| Twilio error                      | (not in Zoho)                           | communication.twilio\_alerts                            |
| team chat                         | (not in Zoho)                           | app.team\_threads, app.team\_thread\_members            |
| the crosswalk                     | Supabase id fields on each record       | integrations.external\_ids                              |
| a tombstone                       | (not in Zoho)                           | a retired row of integrations.external\_ids             |
| a finding                         | (not in Zoho)                           | integrations.drift\_findings                            |
| the integration ledger            | (not in Zoho)                           | integrations.integration\_events                        |
| the webhook log                   | (not in Zoho)                           | integrations.webhook\_events                            |
| the sent-mail ledger              | (not in Zoho)                           | integrations.sent\_messages                             |

## Statuses people say

| We say               | Means                                                                              |
| -------------------- | ---------------------------------------------------------------------------------- |
| draft                | the work order will be invoiced when complete                                      |
| non-billable         | nothing on the job is billable; no invoice will be made                            |
| invoiced             | the invoice exists in QuickBooks and Zoho                                          |
| paid, partially paid | what QuickBooks told us                                                            |
| void                 | the invoice was cancelled in QuickBooks and the CRM; the work order stays invoiced |

The full list is on [Statuses](/reference/statuses).

## The monitor

The monitor's setting lives in the engine's config table under the key `reliability.monitoring`, as the `phase` value.

| We say     | The phase reads |
| ---------- | --------------- |
| off        | disabled        |
| rehearsing | shadow          |
| live       | active          |

| We say                  | Timer that wakes it       | Route on the ops function                            | In Sentry                                                                |
| ----------------------- | ------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------ |
| the evaluator           | reliability-evaluator     | ops/evaluate                                         | cron monitor "Reliability evaluator completion", slug wake-action-worker |
| the maintenance worker  | reliability-maintenance   | ops/maintain                                         |                                                                          |
| the notifier            | reliability-notifications | ops/notify                                           |                                                                          |
| the uptime check        | (Sentry calls it)         | ops/probe, answering technician\_read and monitoring | uptime monitor "Comfort Hub technician access and monitoring"            |
| the stand-in technician |                           | the identity in RELIABILITY\_PROBE\_IDENTITY         |                                                                          |

| We say                                 | Check id                                                           | Condition keys                                                     |
| -------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| Converted leads                        | sales.provisioning                                                 | sales.provisioning                                                 |
| Cancelled work                         | billing.safety                                                     | billing.cancelled\_collectible, billing.cancelled\_paid\_work      |
| Human review                           | business.review                                                    | business.external\_effect\_uncertain, business.review\_required    |
| Property imagery                       | technician.imagery                                                 | technician.imagery\_missing                                        |
| Payroll calendar                       | payroll.readiness                                                  | payroll.calendar\_runway, payroll.timesheets\_unassigned           |
| Card numbers in stored text            | privacy.stored\_data                                               | privacy.sensitive\_data\_stored                                    |
| Checkout payments                      | billing.checkout                                                   | billing.checkout                                                   |
| Unfinished work                        | business.work                                                      | business.work\_incomplete, monitoring.work\_scan\_capacity         |
| Deliveries and logins                  | business.delivery                                                  | business.delivery\_incomplete, monitoring.delivery\_scan\_capacity |
| Invoice amounts                        | billing.invoice\_consistency                                       | billing.invoice\_consistency, monitoring.capacity                  |
| Payment discovery                      | billing.payment\_discovery                                         | (none; a stall shows through billing.checkout)                     |
| Checkout capture clean-up              | privacy.checkout\_capture                                          | (none)                                                             |
| Phone statistics                       | phone.statistics                                                   | (none)                                                             |
| Recording clean-up                     | privacy.recording\_retention                                       | (none)                                                             |
| Did every timer finish (one per timer) | database.\<timer name>, for example database.appointment-reminders | monitoring.execution\_incomplete                                   |
| Nightly sweep                          | sweep.run                                                          | monitoring.execution\_incomplete                                   |
| Database advisors                      | database.advisors                                                  | monitoring.execution\_incomplete                                   |
| The evaluator's own run                | monitoring.evaluate                                                | (none)                                                             |
| Timer outcomes                         | monitoring.database\_jobs                                          | (none)                                                             |
| Timer list                             | monitoring.schedules                                               | monitoring.schedule\_changed                                       |
| Every check finished                   | monitoring.progress                                                | monitoring.execution\_incomplete                                   |
| Queue age                              | monitoring.queue\_age                                              | monitoring.queue\_age                                              |
| capacity (any bounded business check)  |                                                                    | monitoring.scan\_capacity                                          |

The condition keys are the `check` and `condition_id` tags on the Sentry issue; the weight is the `disposition` tag and the spell number is `occurrence`.

| Secret                                                                                                | Vault folder                                    | Read by                                                                |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ---------------------------------------------------------------------- |
| SENTRY\_DSN, SENTRY\_ORG\_SLUG, SENTRY\_OPS\_TOKEN, SENTRY\_ENVIRONMENT, SENTRY\_TRACES\_SAMPLE\_RATE | /edge-functions                                 | the functions: crash reporting, the notifier, the evaluator's check-in |
| RELIABILITY\_PROBE\_SECRET, RELIABILITY\_PROBE\_IDENTITY                                              | /edge-functions                                 | the uptime check's door on the ops function                            |
| SENTRY\_PERSONAL\_TOKEN                                                                               | /operator-tools, and a GitHub repository secret | the gate's production-clean check                                      |

## Routes and inputs

The raw forms other pages may not carry. Say the words in the first column and link here.

| We say                                   | The raw name                                                      |
| ---------------------------------------- | ----------------------------------------------------------------- |
| the review route, to list the open flags | `GET /ops/review`                                                 |
| the review route, to close one flag      | `POST /ops/review/<event id>`                                     |
| the cron token                           | the `x-cron-token` header, carrying `CRON_INVOKE_SECRET`          |
| the monitor's header token               | the `x-monitor-token` header, carrying `RELIABILITY_PROBE_SECRET` |
| resolved, ignored, in review             | `resolved`, `ignored`, `in_review`                                |
| the dead-letter boxes                    | `action_outbound_dlq`, `sync_outbound_dlq`, `webhook_inbound_dlq` |
| the functions folder in the vault        | `/edge-functions`                                                 |
| the database vault folder                | `/postgres-vault`                                                 |
| the GitHub folder                        | `/github-actions`                                                 |
| the gate's own folder                    | `/operator-tools`                                                 |
| the Sentry project                       | `comforthub-backend`, in the `akon-dion` organisation             |

## The workflows on GitHub

Each workflow's name is what GitHub shows on the **Actions** page. The boxes are what you fill in when you run it by hand.

| Workflow                | Its boxes                                                                 |
| ----------------------- | ------------------------------------------------------------------------- |
| **redrive**             | `mode` (`list`, `write`), `queue`, `msg_id`, `max`                        |
| **sweep**               | `max_findings`, `recovery_scheduled_at`                                   |
| **reconcile**           | `mode` (`dry-run`, `write`), `entity`, `max`, `show_values`               |
| **backfill**            | `entity`, `max`, `write`                                                  |
| **backfill-outbound**   | `mode` (`list`, `write`), `entity`, `max`                                 |
| **bootstrap-crosswalk** | `mode` (`dry-run`, `write`), `max_findings`, `max_invalid`, `allow_empty` |

## Related

* [Glossary](/reference/glossary)
* [Who is the source of truth](/systems/who-is-the-source-of-truth)
* [Sync rules by module](/reference/sync-rules-by-module)
