> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/engineering-reference/db/tables/viewpoint-14.md).

# Integrations tables

{% hint style="info" %}
Generated from the staging database schema, with descriptions drafted by agents ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/db/tables/viewpoint-14.md).
{% endhint %}

## Description

Property management system (PMS) integrations (mappings, room statuses, inbound and outbound queues, webhooks), Deputy, and the keys of the Open API and the vendor API.

## Tables

| Name                                                                                                                            | Columns | Comment                                                                                                                                                                                                                                                                                                                                                 | Type       |
| ------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| [cloudbeds\_BuildingSiteMapping](https://docs.snapfix.com/engineering-reference/db/tables/cloudbeds_buildingsitemapping.md)     | 22      | One Cloudbeds property linked to one Snapfix building, with its OAuth client, access and refresh tokens and webhook secret. The client secret, tokens and webhook secret are stored in plain text.                                                                                                                                                      | BASE TABLE |
| [cloudbeds\_InboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/cloudbeds_inboundqueue.md)                   | 22      | One room change received from Cloudbeds, by webhook or poll (source), waiting to be applied to the building's Snapfix rooms.                                                                                                                                                                                                                            | BASE TABLE |
| [cloudbeds\_OutboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/cloudbeds_outboundqueue.md)                 | 19      | One Snapfix room change (condition, do not disturb, comments) waiting to be sent to Cloudbeds. Empty on staging.                                                                                                                                                                                                                                        | BASE TABLE |
| [cloudbeds\_RoomMapping](https://docs.snapfix.com/engineering-reference/db/tables/cloudbeds_roommapping.md)                     | 18      | One Cloudbeds room linked to one Snapfix room (uuid\_tRoom), with its room type. The building sync creates it by matching room names.                                                                                                                                                                                                                   | BASE TABLE |
| [cloudbeds\_RoomStatus](https://docs.snapfix.com/engineering-reference/db/tables/cloudbeds_roomstatus.md)                       | 15      | One Cloudbeds room status that a Snapfix room status can be mapped to.                                                                                                                                                                                                                                                                                  | BASE TABLE |
| [cloudbeds\_RoomStatusMapping](https://docs.snapfix.com/engineering-reference/db/tables/cloudbeds_roomstatusmapping.md)         | 15      | For one building, maps a Cloudbeds room status to a Snapfix housekeeping status (main) and occupancy status (secondary).                                                                                                                                                                                                                                | BASE TABLE |
| [cloudbeds\_webhook](https://docs.snapfix.com/engineering-reference/db/tables/cloudbeds_webhook.md)                             | 7       | One webhook event received from Cloudbeds, with its event object and action, property ID and JSON payload; processed is 1 once it is handled.                                                                                                                                                                                                           | BASE TABLE |
| [cloudbeds\_webhook\_subscription](https://docs.snapfix.com/engineering-reference/db/tables/cloudbeds_webhook_subscription.md)  | 16      | One webhook subscription that the Cloudbeds service registered for a property, with the event object and action it listens to and its endpoint URL.                                                                                                                                                                                                     | BASE TABLE |
| [comtrol\_BuildingSiteMapping](https://docs.snapfix.com/engineering-reference/db/tables/comtrol_buildingsitemapping.md)         | 17      | One Comtrol connection of a building, with the Basic login that Comtrol's system uses to call the Comtrol service. The password is stored in plain text and compared as stored. Empty on staging.                                                                                                                                                       | BASE TABLE |
| [comtrol\_InboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/comtrol_inboundqueue.md)                       | 23      | One Comtrol message received, split into its fields (message type, device model, transaction ID, sequence number, status and room parts), waiting to be applied to Snapfix. Empty on staging.                                                                                                                                                           | BASE TABLE |
| [comtrol\_OutboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/comtrol_outboundqueue.md)                     | 23      | One Snapfix room status update waiting to be sent to Comtrol, in the same field layout as the inbound queue. Empty on staging.                                                                                                                                                                                                                          | BASE TABLE |
| [comtrol\_RoomMapping](https://docs.snapfix.com/engineering-reference/db/tables/comtrol_roommapping.md)                         | 15      | One Comtrol room (name\_number) linked to one Snapfix room (uuid\_tRoom). Empty on staging.                                                                                                                                                                                                                                                             | BASE TABLE |
| [comtrol\_RoomStatus](https://docs.snapfix.com/engineering-reference/db/tables/comtrol_roomstatus.md)                           | 14      | One Comtrol maid code (fCode and fName, for example 1 Room Cleaned), the reference list that Snapfix room statuses map to; 16 rows, none added after April 2025.                                                                                                                                                                                        | BASE TABLE |
| [comtrol\_RoomStatusMapping](https://docs.snapfix.com/engineering-reference/db/tables/comtrol_roomstatusmapping.md)             | 13      | Maps a Comtrol room status (uuid\_comtrol\_RoomStatus) to a Snapfix main room status (uuid\_tBuildingRoomStatusMain). Empty on staging.                                                                                                                                                                                                                 | BASE TABLE |
| [deputy\_auth](https://docs.snapfix.com/engineering-reference/db/tables/deputy_auth.md)                                         | 13      | One Deputy sign-in of a site for the roster import, with the device ID, login URL, auth code and Deputy token response, stored in plain text. The sign-in callback has no login.                                                                                                                                                                        | BASE TABLE |
| [enum\_IntegrationSource](https://docs.snapfix.com/engineering-reference/db/tables/enum_integrationsource.md)                   | 10      | Legacy lookup of three PMS sources of room status changes (comtrol-lodginglink, oracle-opera and guestline, code in uuid); nothing reads it. tPri\_Log\_RoomStatusChange.uuid\_enum\_IntegrationSource holds the Pms enum values (comtrol, guestline, opera, hotsoft, cloudbeds and others) instead.                                                    | BASE TABLE |
| [guestline\_BuildingSiteMapping](https://docs.snapfix.com/engineering-reference/db/tables/guestline_buildingsitemapping.md)     | 19      | One Guestline site linked to one Snapfix building, with its site, interface and operator codes, PMS customer name, webhook key and housekeeping switch.                                                                                                                                                                                                 | BASE TABLE |
| [guestline\_InboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/guestline_inboundqueue.md)                   | 17      | One room status update received from Guestline by webhook (room, housekeeping and maintenance codes), waiting to be applied to Snapfix.                                                                                                                                                                                                                 | BASE TABLE |
| [guestline\_OutboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/guestline_outboundqueue.md)                 | 17      | One Snapfix room status change waiting to be sent to Guestline.                                                                                                                                                                                                                                                                                         | BASE TABLE |
| [guestline\_RoomMapping](https://docs.snapfix.com/engineering-reference/db/tables/guestline_roommapping.md)                     | 18      | One Guestline room (gl\_roomId and gl\_roomExtenstion) linked to one Snapfix room (uuid\_tRoom), with its room type code.                                                                                                                                                                                                                               | BASE TABLE |
| [guestline\_RoomStatus](https://docs.snapfix.com/engineering-reference/db/tables/guestline_roomstatus.md)                       | 16      | One Guestline status code (type and code) that a Snapfix room status can be mapped to; none added after July 2025.                                                                                                                                                                                                                                      | BASE TABLE |
| [guestline\_RoomStatusMapping](https://docs.snapfix.com/engineering-reference/db/tables/guestline_roomstatusmapping.md)         | 14      | For a building, maps a Guestline room status (uuid\_gl\_RoomStatus) to a Snapfix main room status and a secondary status.                                                                                                                                                                                                                               | BASE TABLE |
| [guestline\_business](https://docs.snapfix.com/engineering-reference/db/tables/guestline_business.md)                           | 15      | One Guestline setup of a Snapfix group (uuid\_tBusiness) under a Guestline account (uuid\_guestline\_parent), with its admin user, enabled flag and integration type. Only apipy reads and writes it.                                                                                                                                                   | BASE TABLE |
| [guestline\_business\_job](https://docs.snapfix.com/engineering-reference/db/tables/guestline_business_job.md)                  | 14      | One task created for a Guestline group setup, linked to the Snapfix task (uuid\_tJob), with the Guestline room ID, a hash and log JSON. No in-scope code reads or writes it; about 1,800 rows, none added after December 2023 \[[ASK-242](https://github.com/snapfix/docs/blob/main/ASK.md#ask-242-can-the-unused-copy-and-scratch-tables-be-dropped)]. | BASE TABLE |
| [guestline\_parent](https://docs.snapfix.com/engineering-reference/db/tables/guestline_parent.md)                               | 20      | One Guestline account of a site (uuid\_tParent), with its admin user, Guestline site, interface and operator codes, password fields and two JSON code maps. apipy encrypts the password into gl\_pw\_encrypted with a key kept in the code.                                                                                                             | BASE TABLE |
| [hotsoft\_BuildingSiteMapping](https://docs.snapfix.com/engineering-reference/db/tables/hotsoft_buildingsitemapping.md)         | 20      | One Hotsoft hotel linked to one Snapfix building, with its hotel URL, hotel code, provider key, PMS customer name and housekeeping switch. The Basic login password and the webhook key are stored in plain text.                                                                                                                                       | BASE TABLE |
| [hotsoft\_InboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/hotsoft_inboundqueue.md)                       | 14      | One room status change received from Hotsoft (room ID and status code), waiting to be applied to Snapfix.                                                                                                                                                                                                                                               | BASE TABLE |
| [hotsoft\_OutboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/hotsoft_outboundqueue.md)                     | 14      | One Snapfix room status change waiting to be sent to Hotsoft.                                                                                                                                                                                                                                                                                           | BASE TABLE |
| [hotsoft\_RoomMapping](https://docs.snapfix.com/engineering-reference/db/tables/hotsoft_roommapping.md)                         | 15      | One Hotsoft room (hotsoft\_roomId, with its description) linked to one Snapfix room.                                                                                                                                                                                                                                                                    | BASE TABLE |
| [hotsoft\_RoomStatus](https://docs.snapfix.com/engineering-reference/db/tables/hotsoft_roomstatus.md)                           | 17      | One Hotsoft room status; fCode is the code matched against the status Hotsoft sends, and hotsoft\_RoomStatusMapping maps it to Snapfix.                                                                                                                                                                                                                 | BASE TABLE |
| [hotsoft\_RoomStatusMapping](https://docs.snapfix.com/engineering-reference/db/tables/hotsoft_roomstatusmapping.md)             | 13      | Maps one Hotsoft room status to a Snapfix main room status of a building (uuid\_tBuildingRoomStatusMain).                                                                                                                                                                                                                                               | BASE TABLE |
| [jonaschorum\_BuildingSiteMapping](https://docs.snapfix.com/engineering-reference/db/tables/jonaschorum_buildingsitemapping.md) | 18      | The Jonas Chorum connection of one building: partner and hotel codes, SOAP endpoint, partner token and housekeeping switch.                                                                                                                                                                                                                             | BASE TABLE |
| [jonaschorum\_InboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/jonaschorum_inboundqueue.md)               | 17      | One room status read from Jonas Chorum, by poll or push, waiting to be applied to Snapfix.                                                                                                                                                                                                                                                              | BASE TABLE |
| [jonaschorum\_OutboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/jonaschorum_outboundqueue.md)             | 16      | One Snapfix room status change waiting to be sent to Jonas Chorum.                                                                                                                                                                                                                                                                                      | BASE TABLE |
| [jonaschorum\_PushEventLog](https://docs.snapfix.com/engineering-reference/db/tables/jonaschorum_pusheventlog.md)               | 6       | One raw push message from Jonas Chorum, with its event type, hotel code and XML payload, stored before it is handled.                                                                                                                                                                                                                                   | BASE TABLE |
| [jonaschorum\_RoomMapping](https://docs.snapfix.com/engineering-reference/db/tables/jonaschorum_roommapping.md)                 | 17      | One Snapfix room matched to a Jonas Chorum room number and room type in one building; the room sync creates and updates it.                                                                                                                                                                                                                             | BASE TABLE |
| [jonaschorum\_RoomStatus](https://docs.snapfix.com/engineering-reference/db/tables/jonaschorum_roomstatus.md)                   | 15      | One Jonas Chorum housekeeping status (fName) in the status catalog; jonaschorum\_RoomStatusMapping maps it to Snapfix statuses.                                                                                                                                                                                                                         | BASE TABLE |
| [jonaschorum\_RoomStatusMapping](https://docs.snapfix.com/engineering-reference/db/tables/jonaschorum_roomstatusmapping.md)     | 14      | Maps a Jonas Chorum room status to a Snapfix main and secondary room status; read when a room status is applied or sent.                                                                                                                                                                                                                                | BASE TABLE |
| [opera\_BuildingSiteMapping](https://docs.snapfix.com/engineering-reference/db/tables/opera_buildingsitemapping.md)             | 26      | The OPERA connection of one building: chain code, client and hotel IDs, client secret, streaming settings and webhook key.                                                                                                                                                                                                                              | BASE TABLE |
| [opera\_InboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/opera_inboundqueue.md)                           | 16      | One housekeeping status change from OPERA, by poll or event stream, waiting to be applied to Snapfix.                                                                                                                                                                                                                                                   | BASE TABLE |
| [opera\_OutboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/opera_outboundqueue.md)                         | 15      | One Snapfix room status change waiting to be sent to OPERA; the room status endpoint writes it.                                                                                                                                                                                                                                                         | BASE TABLE |
| [opera\_RoomMapping](https://docs.snapfix.com/engineering-reference/db/tables/opera_roommapping.md)                             | 15      | One OPERA room (opera\_roomId, with its description) linked to a Snapfix room; the building sync writes it.                                                                                                                                                                                                                                             | BASE TABLE |
| [opera\_RoomStatus](https://docs.snapfix.com/engineering-reference/db/tables/opera_roomstatus.md)                               | 15      | One OPERA room status in the status catalog; opera\_RoomStatusMapping maps it to Snapfix statuses.                                                                                                                                                                                                                                                      | BASE TABLE |
| [opera\_RoomStatusMapping](https://docs.snapfix.com/engineering-reference/db/tables/opera_roomstatusmapping.md)                 | 14      | Maps an OPERA room status to a Snapfix main and secondary room status of a building.                                                                                                                                                                                                                                                                    | BASE TABLE |
| [opera\_streaming\_state](https://docs.snapfix.com/engineering-reference/db/tables/opera_streaming_state.md)                    | 3       | The last offset saved for one OPERA event stream. The stream subscription does not send it back (that line is commented out), so it is only logged \[[ASK-278](https://github.com/snapfix/docs/blob/main/ASK.md#ask-278-should-the-opera-stream-resume-from-its-saved-offset)].                                                                         | BASE TABLE |
| [opera\_webhook](https://docs.snapfix.com/engineering-reference/db/tables/opera_webhook.md)                                     | 5       | One raw event from the OPERA event stream (event name, JSON payload, hotel ID); the stream code writes it and no code reads it.                                                                                                                                                                                                                         | BASE TABLE |
| [stayntouch\_BuildingSiteMapping](https://docs.snapfix.com/engineering-reference/db/tables/stayntouch_buildingsitemapping.md)   | 20      | The Stayntouch connection of one building: auth and connect URLs, client ID and secret, hotel ID and webhook key.                                                                                                                                                                                                                                       | BASE TABLE |
| [stayntouch\_InboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/stayntouch_inboundqueue.md)                 | 15      | One room or service status change from Stayntouch (webhook, poll or the service's outbound endpoint), waiting to be applied to Snapfix.                                                                                                                                                                                                                 | BASE TABLE |
| [stayntouch\_OutboundQueue](https://docs.snapfix.com/engineering-reference/db/tables/stayntouch_outboundqueue.md)               | 15      | One Snapfix room or service status change waiting to be sent to Stayntouch.                                                                                                                                                                                                                                                                             | BASE TABLE |
| [stayntouch\_RoomMapping](https://docs.snapfix.com/engineering-reference/db/tables/stayntouch_roommapping.md)                   | 15      | One Stayntouch room (stayntouch\_roomId, with its description) linked to a Snapfix room.                                                                                                                                                                                                                                                                | BASE TABLE |
| [stayntouch\_RoomStatus](https://docs.snapfix.com/engineering-reference/db/tables/stayntouch_roomstatus.md)                     | 16      | One Stayntouch status in the status catalog, matched by fCode to the codes in incoming changes; stayntouch\_RoomStatusMapping maps it to Snapfix.                                                                                                                                                                                                       | BASE TABLE |
| [stayntouch\_RoomStatusMapping](https://docs.snapfix.com/engineering-reference/db/tables/stayntouch_roomstatusmapping.md)       | 14      | Maps a Stayntouch status to a Snapfix main and secondary room status of a building.                                                                                                                                                                                                                                                                     | BASE TABLE |
| [stayntouch\_webhook](https://docs.snapfix.com/engineering-reference/db/tables/stayntouch_webhook.md)                           | 5       | Raw log of Stayntouch webhook calls (event, JSON payload, hotel ID); rows are written even when the signature is wrong, because the rejection is commented out.                                                                                                                                                                                         | BASE TABLE |
| [tPri\_Api\_Simple\_SecretKey](https://docs.snapfix.com/engineering-reference/db/tables/tpri_api_simple_secretkey.md)           | 22      | A public API key: only its SHA-256 hash is stored, with its validity dates, rate limits, permissions and AI switch. The API hashes the caller's key and looks it up here.                                                                                                                                                                               | BASE TABLE |
| [tPri\_Parent\_Api](https://docs.snapfix.com/engineering-reference/db/tables/tpri_parent_api.md)                                | 15      | One older Open API key of a site, for a customer's own integration, with a validity window and a disabled flag. No row is newer than 2023-04.                                                                                                                                                                                                           | BASE TABLE |

## Relations

```mermaid
erDiagram

"cloudbeds_RoomStatusMapping" }o--o| "cloudbeds_RoomStatus" : "FOREIGN KEY (uuid_cloudbeds_RoomStatus) REFERENCES cloudbeds_RoomStatus (uuid)"
"comtrol_RoomStatusMapping" }o--o| "comtrol_RoomStatus" : "FOREIGN KEY (uuid_comtrol_RoomStatus) REFERENCES comtrol_RoomStatus (uuid)"
"guestline_RoomStatusMapping" }o--o| "guestline_RoomStatus" : "FOREIGN KEY (uuid_gl_RoomStatus) REFERENCES guestline_RoomStatus (uuid)"
"hotsoft_RoomStatusMapping" }o--o| "hotsoft_RoomStatus" : "FOREIGN KEY (uuid_hotsoft_RoomStatus) REFERENCES hotsoft_RoomStatus (uuid)"
"jonaschorum_RoomStatusMapping" }o--o| "jonaschorum_RoomStatus" : "FOREIGN KEY (uuid_jonaschorum_RoomStatus) REFERENCES jonaschorum_RoomStatus (uuid)"
"opera_RoomStatusMapping" }o--o| "opera_RoomStatus" : "FOREIGN KEY (uuid_opera_RoomStatus) REFERENCES opera_RoomStatus (uuid)"
"stayntouch_RoomStatusMapping" }o--o| "stayntouch_RoomStatus" : "FOREIGN KEY (uuid_stayntouch_RoomStatus) REFERENCES stayntouch_RoomStatus (uuid)"

"cloudbeds_BuildingSiteMapping" {
}
"cloudbeds_InboundQueue" {
}
"cloudbeds_OutboundQueue" {
}
"cloudbeds_RoomMapping" {
}
"cloudbeds_RoomStatus" {
  varchar_255_ uuid
}
"cloudbeds_RoomStatusMapping" {
  varchar_255_ uuid_cloudbeds_RoomStatus
}
"cloudbeds_webhook" {
}
"cloudbeds_webhook_subscription" {
}
"comtrol_BuildingSiteMapping" {
}
"comtrol_InboundQueue" {
}
"comtrol_OutboundQueue" {
}
"comtrol_RoomMapping" {
}
"comtrol_RoomStatus" {
  varchar_255_ uuid
}
"comtrol_RoomStatusMapping" {
  varchar_255_ uuid_comtrol_RoomStatus
}
"deputy_auth" {
}
"enum_IntegrationSource" {
}
"guestline_BuildingSiteMapping" {
}
"guestline_InboundQueue" {
}
"guestline_OutboundQueue" {
}
"guestline_RoomMapping" {
}
"guestline_RoomStatus" {
  varchar_255_ uuid
}
"guestline_RoomStatusMapping" {
  varchar_255_ uuid_gl_RoomStatus
}
"guestline_business" {
}
"guestline_business_job" {
}
"guestline_parent" {
}
"hotsoft_BuildingSiteMapping" {
}
"hotsoft_InboundQueue" {
}
"hotsoft_OutboundQueue" {
}
"hotsoft_RoomMapping" {
}
"hotsoft_RoomStatus" {
  varchar_255_ uuid
}
"hotsoft_RoomStatusMapping" {
  varchar_255_ uuid_hotsoft_RoomStatus
}
"jonaschorum_BuildingSiteMapping" {
}
"jonaschorum_InboundQueue" {
}
"jonaschorum_OutboundQueue" {
}
"jonaschorum_PushEventLog" {
}
"jonaschorum_RoomMapping" {
}
"jonaschorum_RoomStatus" {
  varchar_255_ uuid
}
"jonaschorum_RoomStatusMapping" {
  varchar_255_ uuid_jonaschorum_RoomStatus
}
"opera_BuildingSiteMapping" {
}
"opera_InboundQueue" {
}
"opera_OutboundQueue" {
}
"opera_RoomMapping" {
}
"opera_RoomStatus" {
  varchar_255_ uuid
}
"opera_RoomStatusMapping" {
  varchar_255_ uuid_opera_RoomStatus
}
"opera_streaming_state" {
}
"opera_webhook" {
}
"stayntouch_BuildingSiteMapping" {
}
"stayntouch_InboundQueue" {
}
"stayntouch_OutboundQueue" {
}
"stayntouch_RoomMapping" {
}
"stayntouch_RoomStatus" {
  varchar_255_ uuid
}
"stayntouch_RoomStatusMapping" {
  varchar_255_ uuid_stayntouch_RoomStatus
}
"stayntouch_webhook" {
}
"tPri_Api_Simple_SecretKey" {
}
"tPri_Parent_Api" {
}
```

***

> Generated by [tbls](https://github.com/k1LoW/tbls)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/engineering-reference/db/tables/viewpoint-14.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
