Serpkite Com Webhooks

generated: '2026-10-31'
method: searched
generator: extract-docs-artifacts.py (local)
source: https://serpkite.com/docs/webhooks.md
sources:
- https://serpkite.com/docs/webhooks.md
- https://serpkite.com/docs/webhooks
description: SerpKite can POST finished batch jobs, crawls, research tasks and monitor results to a URL you control. Deliveries are signed with
  an HMAC‑SHA256 signature using a webhook secret (starts with `whsec_`). The signature is provided in the `X-SerpKite-Signature` header together
  with a timestamp (`X-SerpKite‑Timestamp`). Retries are performed for batch, crawl and research deliveries on an internal schedule, and monitor
  deliveries are attempted up to three times per run (undelivered results are sent again with the next run).
events:
- event: batch.completed
  description: A batch job finished (succeeded or failed). The body contains the job fields `event`, `id`, `status`, `endpoint`, `created_at`,
    `completed_at`, `credits_used` and either `result` or `error`.
- event: crawl.completed
  description: 'A crawl completed, failed or was canceled. The body includes `event`, `id`, `kind`, `status`, `created_at`, `completed_at`, `credits_used`,
    `poll_url` and either `result` (pages, omitted with `result_omitted: true` above 4 MB) or `error`.'
- event: research.completed
  description: 'A research task completed, failed or was canceled. The payload has the same shape as `crawl.completed` with `kind: "research"`
    and `result` holding the report, citations, sources, queries, stats and optional `output` when an `output_schema` is provided.'
- event: monitor.results
  description: A monitor run found new results it had not seen before (AI‑assistant monitors send every run). The body contains `event`, `monitor_id`,
    `run_id`, `name`, `endpoint`, query fields (`q`, `url` or `prompt`), `metadata`, `first_run`, `run_at`, `new_results` and `credits_used`.
    For AI‑assistant monitors, `new_results` includes `text`, `markdown`, `model`, `sources`, `new_sources`, `search_queries`, `products` and
    optional `mentions`.
delivery:
  signature: HMAC‑SHA256 over `<timestamp>.<raw_body>` using the webhook secret, provided in `X-SerpKite-Signature` (prefixed with `v1=`).
  content_type: application/json (header `Content-Type`), `User-Agent` is `SerpKite-Webhooks/1.0`.
note: 'Retries: batch, crawl and research deliveries are retried on an internal schedule; monitor deliveries are attempted up to 3 times per run,
  with undelivered results sent again on the next run.'
docs: https://serpkite.com/docs/webhooks.md