Romm Webhooks

generated: '2026-10-28'
method: searched
generator: extract-docs-artifacts.py (local)
source: https://docs.romm.app/latest/using/notifications/
sources:
- https://docs.romm.app/latest/using/notifications/
description: RomM can deliver notifications via webhook channels. Each webhook POST contains a JSON payload and is signed with an HMAC‑SHA256
  signature.
events:
- event: scan_completed
  description: Sent when a scan finishes successfully.
- event: scan_failed
  description: Sent when a scan ends with an error.
- event: task_completed
  description: Sent when a manually‑run task finishes successfully.
- event: task_failed
  description: Sent when a manually‑run task ends with an error.
- event: streaming_session_ended
  description: Sent when another user ends your streaming session.
- event: role_changed
  description: Sent when an admin changes a user's role.
- event: channel_disabled
  description: Sent when a notification channel is turned off after repeated delivery failures.
- event: device_install_completed
  description: Sent when a game is installed on a device successfully.
- event: device_install_failed
  description: Sent when a game installation on a device fails.
- event: custom
  description: Sent for notifications created through the API with a user‑defined kind.
delivery:
  content_type: application/json; charset=utf-8 (Content-Type header is required). The request must respond with a 2xx status within 15 seconds;
    redirects are not followed and count as failures.
note: 'Only admin webhooks may point at private or local addresses; other users are limited to public hosts. The request includes a User-Agent:
  RomM header and must be answered within 15 seconds. A failed delivery is retried after 30 seconds, 2 minutes, and 10 minutes, up to 10 consecutive
  failures, after which the channel is disabled and a notification is generated.'
docs: https://docs.romm.app/latest/using/notifications/