- new results detected by your query (events)
- run completions
- errors (if a run fails)
event_group_id so you can
fetch the full set of results that belong to the same discovery.
Event Groups
Event groups are primarily relevant for webhook users. When a webhook fires
with a
monitor.event.detected event, it returns an event_group_id that you
use to retrieve the complete set of results.event_group_id.
When a monitor detects new results, it creates an event group. Subsequent runs can add
additional events to the same group if they’re related to the same discovery.
Use event groups to present the full context of a discovery (multiple sources, follow‑up updates) as one
unit. To fetch the complete set of results for a discovery, use the GET event group endpoint
with the event_group_id received in your webhook payload.
Other Events
Besides events with new results, monitors emit:- Completion (
type: "completion"): indicates a run finished successfully. - Error (
type: "error"): indicates a run failed.
Runs with non-empty events are not included in completions. This means that a
run will correspond to only one of succesful event detection, completion or
failure.
Accessing Events
You can receive events via webhooks (recommended) or retrieve them via endpoints.-
Webhooks (recommended): lowest latency, push-based delivery.
Subscribe to
monitor.event.detected,monitor.execution.completed, andmonitor.execution.failed. See Monitor webhooks for more details on setting up webhooks. -
Endpoints (for history/backfill):
GETmonitor events — list events for a monitor in reverse chronological order (up to recent ~300 runs).- This flattens out events, meaning that multiple events from the same event group will be listed as different events.
GETevent group - list all events given anevent_group_id.