Skip to main content
Every Monitors webhook delivery is an HTTP POST with a JSON body: one event in a fixed envelope, signed with the monitor’s webhook.secret. This page lists the headers, the envelope fields, each event type and the objects in data, so your handler can parse every event it subscribes to. To set up a handler and verify signatures, see Receive monitor webhooks.

Headers

A delivery can carry other headers. Verify it with these three, as Verify the signature shows.

Envelope

Every event has the same five top-level fields:

Event types

A monitor sends only the types its webhook.events lists. If webhook.events is empty or missing, it sends every type in this table.

Objects in data

monitor

monitor is the monitor as Get a monitor returns it, with its state after the change. It never carries webhook.secret.

run

run is a run as Get a run returns it:

result

result in monitor.result.found and monitor.result.changed has the fields of a result from List results, except id and same_story:

change

change says how a page differs from the version the monitor stored before:

Example bodies

A monitor.result.found event, formatted here for reading. Keenable sends the body as compact JSON, so verify the bytes you received, not a reformatted copy:
monitor.result.found
A monitor.run.completed event for a run that found nothing new:
monitor.run.completed
Values in these examples are illustrative. Field names and types match what the API sends.

Types for your handler

If your SDK version doesn’t have typed webhook events yet, these TypeScript types describe the envelope and the objects above. Use them after you verify the signature:
keenable-webhook.ts
Switch on type to read the right field of data. For example, event.type === "monitor.result.found" means event.data.result is set. SDK 0.2.0 and later return these events typed from verify_webhook (verifyWebhook in TypeScript, VerifyWebhook in Go).