Admin, Security & Settings · Synthetic Property 1

External Systems & Add-ons

Customer-configurable optional connections and paid add-ons.

MarketplaceConnectionsSetup GuideCredentialsMappingTestsHealthOperationsEntitlementsAPI Keys & WebhooksUsage

Setup guide · External Badge / Sign-In Hardware

Badge reads; tap sign-in

What you need first

Your badge reader company's integration details from their support team.

Find your provider's instructions for the keys (opens a web search). Look for words like API keys, integrations or developer settings in your provider's admin area.

If you don't have a provider yet, the built-in feature keeps working. Your own provider's help is the source of truth.

The steps

  1. Open External Systems & Add-ons, Marketplace and choose External Badge / Sign-In Hardware.
  2. Get the details above from your provider. Keep them private; never put them in a message or note.
  3. Paste them into the connection form. They are stored separately for Test and Live.
  4. Allow only what this connection needs: Badge reads; tap sign-in.
  5. Match your provider's names to ours on the Mapping tab, then press Test.
  6. It shows Connected only after the test passes. Watch its Health, and use Safe Disable to turn it off at any time.
Technical steps from the build package
  1. Settings > External Systems & Add-ons > Marketplace: activate External Badge / Sign-In Hardware (paid add-on where applicable).
  2. Enter the credentials your provider gives you (kept separate per environment).
  3. Grant only these permissions: Badge reads; tap sign-in.
  4. Map codes and fields on the Mapping tab.
  5. Run Test; status becomes Connected only after a pass.
  6. Watch Health; use Safe Disable to turn it off.

Without this connection: Staff PIN sign-in.

Degraded: warnings, partial sync, fallback for impaired functions. Down: Staff PIN sign-in; queued writes replay safely on recovery.

Setup Guide · External Systems & Add-ons · Hospitality Operating System