A monitor run found results it had not seen before

Sent to the monitor's webhook_url (when it has one) only when a run finds new results (the first run sends everything it found, with first_run: true). Same signature headers as the other webhooks, with X-SerpKite-Event: monitor.results and X-SerpKite-Delivery: <run id>. Tried up to 3 times per run; results that could not be delivered stay new for the next run (and are in the run history either way).

postWebhookmonitor.results

Payload

event'monitor.results' required
monitor_idstring uuid required
run_idstring uuid required

Also the X-SerpKite-Delivery header; use it to deduplicate retries

namestring required
endpoint'search' | 'news' | 'webpage' required
qstring required

The saved query (empty for webpage monitors)

urlstring

webpage monitors only

metadataobject nullable

The monitor's metadata

first_runboolean required

The first run since the monitor was created or its search changed

run_atstring date-time required
new_resultsobject[] required

Results not seen in earlier runs (OrganicResult-shaped for search, NewsResult for news, MonitorPageChange for webpage)

credits_usednumber required

This run's price

Response

Any 2xx acknowledges the delivery

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.