Endpoint Selection
Delivery Mode Selection
Practical Recommendations
- Start with
check-onceto validate condition wording. - Move to
live-monitorwhen you need trigger detection over time. - Use
live-digestwhen you need summaries, not binary triggers. - Choose polling first for simple backend workflows.
- Add webhooks or SSE when you need push delivery.
Delivery Behavior by Endpoint
POST /check-once
- Returns one JSON result.
- No job lifecycle to track.
POST /live-monitor
webhook_urlpresent: webhook mode.Accept: text/event-streamand nowebhook_url: SSE mode.- Otherwise: polling mode (
job_id+GET /jobs/{job_id}).
POST /live-digest
Accept: text/event-streamand nowebhook_url: SSE mode.webhook_urlpresent: webhook mode.- Otherwise: polling mode.
Next Steps
- Polling implementation: Use Polling
- Webhook implementation: Use Webhooks
- SSE implementation: Use SSE Streaming