Fire Docs

Archives
Log in
Subscribe
August 6, 2026

6 August 2026 — Component health heartbeats for kiosks, KDS and POS

Kiosks, KDS stations and POS terminals can now report that they are alive, and Fire's availability dashboard reads the fleet from those beats. The endpoint is POST /external/component-health and needs an API key with the component-health:write scope.

  • Component health — one beat per cycle with componentType, componentId, storeId and status. Optional sentAt, offlineSince, degradedReason, appVersion and a free-form details. Answers 204 No Content.
  • X-Heartbeat-Interval — every 204 carries the cadence in force, in seconds. Adopt it on the next cycle: that is how the interval is reconfigured without shipping a release.
  • A componentId must be stable — if it changes between reboots, Fire sees a different component: the old one is retired after 7 days and the new one starts with no history.
  • degradedReason uses a shared vocabulary — printer_down, pinpad_down, backend_unreachable, queue_backlog, peripheral_other. The details keys for kds_station are still to be agreed with the KDS team.

Note status accepts only online and degraded. There is no down: a device cannot declare itself dead — Fire infers the outage from the missing heartbeat, after two missed intervals.


Español

6 de agosto de 2026 — Latidos de salud de kioscos, KDS y cajas

Los kioscos, las pantallas KDS y las cajas POS ya pueden reportar que están vivos, y el tablero de disponibilidad de Fire lee la flota a partir de esos latidos. El endpoint es POST /external/component-health y necesita una API key con el scope component-health:write.

  • Salud de componentes — un latido por ciclo con componentType, componentId, storeId y status. Opcionales: sentAt, offlineSince, degradedReason, appVersion y un details libre. Responde 204 No Content.
  • X-Heartbeat-Interval — cada 204 trae la cadencia vigente, en segundos. Adoptala en el próximo ciclo: así se reconfigura el intervalo sin publicar una release.
  • El componentId tiene que ser estable — si cambia entre reinicios, para Fire es otro componente: el viejo se da de baja a los 7 días y el nuevo arranca sin historia.
  • degradedReason usa un vocabulario común — printer_down, pinpad_down, backend_unreachable, queue_backlog, peripheral_other. Las claves de details para kds_station todavía están por acordar con el equipo de KDS.

Note status solo acepta online y degraded. No existe down: un equipo no puede declararse muerto — Fire infiere la caída por la ausencia de latido, tras dos intervalos perdidos.


Português

6 de agosto de 2026 — Batimentos de saúde de quiosques, KDS e caixas

Quiosques, telas KDS e caixas POS já podem informar que estão vivos, e o painel de disponibilidade do Fire lê a frota a partir desses batimentos. O endpoint é POST /external/component-health e exige uma API key com o escopo component-health:write.

  • Saúde de componentes — um batimento por ciclo com componentType, componentId, storeId e status. Opcionais: sentAt, offlineSince, degradedReason, appVersion e um details livre. Responde 204 No Content.
  • X-Heartbeat-Interval — cada 204 traz a cadência vigente, em segundos. Adote-a no próximo ciclo: é assim que o intervalo é reconfigurado sem publicar uma release.
  • O componentId precisa ser estável — se mudar entre reinícios, para o Fire é outro componente: o antigo é baixado após 7 dias e o novo começa sem histórico.
  • degradedReason usa um vocabulário comum — printer_down, pinpad_down, backend_unreachable, queue_backlog, peripheral_other. As chaves de details para kds_station ainda serão combinadas com o time de KDS.

Note status aceita apenas online e degraded. Não existe down: um equipamento não pode se declarar morto — o Fire infere a queda pela ausência do batimento, após dois intervalos perdidos.

Atualizado em EN / ES / PT.


Read the full changelog · Ver el registro completo · Ver o registro completo

Don't miss what's next. Subscribe to Fire Docs:
← Newer 7 August 2026 — Price lists: new user manual Older → 4 August 2026 — New assignedAt field on menu and product events
Powered by Buttondown, the easiest way to start and grow your newsletter.