Docs › API
API
HoldAlarms has a small HTTP surface: one endpoint that receives alerts, one for heartbeat beats, and a read-only MCP endpoint for AI assistants. Settings are changed on the dashboard, not through an API.
Receive an alert
POST https://api.holdalarms.com/hook/<token>
- Body: up to 1 MB, any content type; it is forwarded unchanged with the same content type.
- Optional header
Idempotency-Key: alerts with the same key within 24 hours are treated as one. Anidempotency_keyin the URL is ignored. - Reply
200once the alert is queued, as JSON withok,id,alert_id,destinationsandduplicate(true when the same alert arrived within 20 seconds). 401: unknown token.402: the 7-day trial is over.403: the 300 trial alerts are used.413: body too large.429: too many requests.
What your endpoint receives
The original body and content type, plus these headers:
X-HookWatch-Event-Id: the delivery's id.X-HookWatch-Event-Hash: SHA-256 of the content type and body.X-HookWatch-Attempt: 1 for the first attempt, higher on retries.Idempotency-Key: the same on every attempt of one delivery.
Reply with any 2xx within 10 seconds. See Retries & failed alerts for everything else.
Send a heartbeat beat
POST https://api.holdalarms.com/heartbeat/<heartbeat token>. The body is read and discarded. Reply 200, or 404 for an unknown heartbeat. Beats are not alerts and are never forwarded.
Read your status from an AI assistant
POST https://api.holdalarms.com/mcp with a read-only token. See MCP & AI.
← Retries & failed alerts · MCP & AI →
HoldAlarms is not affiliated with TradingView. TradingView is a trademark of TradingView, Inc.