Integration
Sitejar webhooks
Sitejar webhooks send a signed JSON POST to your own HTTPS endpoint when a scan completes, when a site's overall score drops 5 points or more, or when a scan finds new Confirmed High findings. Each delivery carries ids, the host, scores, counts and a report link, signed with HMAC-SHA256 in the Sitejar-Signature header, so you can start a deploy check, update a dashboard or open a ticket in a tool Sitejar does not connect to.
On Business and above.
What Sitejar webhooks do
A webhook is the general-purpose integration: Sitejar tells your system that something happened, and your code decides what to do. You register an endpoint, choose its events, and Sitejar sends one signed request per event, retrying when your endpoint is down.
There are three events, plus a test:
- scan.completed: a scan of a site finished. Carries the scores by dimension, the overall score, the report id and the report url.
- score.dropped: the site's overall score fell by 5 points or more against its previous completed scan. Carries the new and previous overall score and the change.
- finding.new_high: the scan found Confirmed findings of High or Critical severity that were not there before. Carries their count.
- ping: the test event that "Send test" sends. You cannot subscribe to it.
Every event carries the scan id, the site id, the host, when the scan finished and a link to the report. None carries finding evidence or page content.
Who Sitejar webhooks are for
Developers and platform teams who want scan results inside their own systems: a release pipeline that waits for a scan before promoting a build, an internal dashboard of every client site's score, a ticketing tool Sitejar has no integration for, or an automation platform that accepts incoming webhooks.
Adding and removing webhooks is for an Owner or Admin of the workspace. If you want to start scans and read full results from code, use the Sitejar REST API alongside webhooks. If you only want a message in a chat channel, the Slack integration and Microsoft Teams integration need no code at all.
Webhook use cases for website scans
Gate a release on the scan
Subscribe to scan.completed, read overallScore and scores, and fail or hold the release when they fall below your bar.
Open tickets in another tool
Subscribe to finding.new_high and create a ticket in your own system with the count and the report link.
Keep a score history of your own
Store each scan.completed payload to chart every site's scores over time in the dashboard you already use.
Page someone on a big drop
Subscribe to score.dropped and route it to your on-call tool when change is large.
How to set up a Sitejar webhook
- Sign in to Sitejar as an Owner or Admin and open Developers, then Webhooks.
- Under "Add a webhook", enter your "Endpoint url". It must be a public https url.
- Tick the events it should receive.
- Under "Sites", keep "Every site" or choose one site. A single-page scan that belongs to no site reaches only an every-site webhook.
- Choose "Add webhook". Copy "Your signing secret" now: it is shown only once.
- Choose "Send test" to post a ping to your endpoint. Sitejar tells you whether it was delivered and, if not, why.
- Verify the Sitejar-Signature header on every request before trusting it (below).
Webhooks can also be created and removed through the public API with an API key, at /v1/public/webhooks. The API reference covers authentication.
How to verify the Sitejar-Signature header
The header reads t=<unix seconds>,v1=<hex>. The hex is HMAC-SHA256 of the timestamp, a full stop and the raw request body, keyed with your whole signing secret, including its whsec_ prefix. Compute it over the body exactly as received, compare in constant time, and consider rejecting a timestamp far from your own clock. In Node:
import crypto from 'node:crypto';// rawBody: the request body exactly as received, before any JSON parsing.// header: the Sitejar-Signature header. secret: the whole whsec_ value.export function verifySitejar(rawBody, header, secret) { const parts = Object.fromEntries(header.split(',').map((part) => part.split('='))); const expected = crypto.createHmac('sha256', secret).update(`${parts.t}.${rawBody}`).digest('hex'); const a = Buffer.from(expected); const b = Buffer.from(parts.v1 ?? ''); return a.length === b.length && crypto.timingSafeEqual(a, b);}A score.dropped delivery looks like this:
{ "id": "evt_1042", "type": "score.dropped", "createdAt": "2026-11-03T09:14:05Z", "data": { "scanId": "...", "siteId": "...", "host": "example.com", "finishedAt": "2026-11-03T09:13:58Z", "overallScore": 74, "previousOverallScore": 81, "change": -7, "reportUrl": "https://sitejar.app/app/sites/.../scans/..." }}What Sitejar sends, and what it stores
Each request is a POST with a JSON body of four fields: id (evt_ and a number), type (the event), createdAt, and data. The data fields are listed above for each event.
Sitejar stores the endpoint url and the signing secret encrypted with AES-256-GCM, the host to show, the events and the site, and for each delivery: the event, its payload (the same ids, host, scores and counts), its status, the number of attempts and the last error. The url and secret are never shown again after you add the webhook.
No sign-in to another service is involved, so no third-party token is stored and no personal data from your endpoint is kept. Sitejar records only whether your endpoint accepted the request.
What happens after each scan
When a scan finishes, Sitejar queues one delivery per event per webhook, once: each webhook gets a given event for a given scan at most one time. Only scans that finish after a webhook was created reach it, and a removed site's scans send nothing.
A delivery that fails is retried after a growing wait of 1, 4, 9, 16 and 25 minutes, six attempts in all. Under "Deliveries" each webhook lists its last 50 deliveries as Delivered, Waiting to retry, Sending, Failed or Not sent, and a failed one can be sent again with "Retry". A retry keeps the same id, so your endpoint can use the id to ignore a repeat.
Which plans include Sitejar webhooks
Webhooks are on Business and above. To see everything each plan includes, compare plans on the pricing page.
The REST API and CI checks are on every plan, Free included, with an hourly request limit per plan. See the developer API for the limits and the CI setup.
Webhook limits
- Up to 10 webhooks per workspace. Remove one to add another.
- A public https endpoint only. Sitejar refuses a url that resolves to a private or internal address, both when you add it and on every delivery.
- Each request waits at most 10 seconds for an answer and follows no redirects. Any 2xx response counts as delivered.
- Six attempts per delivery, and the log shows the last 50 deliveries per webhook.
- Payloads carry ids, the host, scores, counts and links, never finding evidence or page content. Use the API to read findings.
Troubleshooting Sitejar webhooks
"Test event not delivered: The channel answered 500"
Sitejar reached your endpoint and it answered with that status. Check your endpoint's own logs: the test body is a ping with the message "A test event from Sitejar. Nothing changed."
"The channel did not answer within 10 seconds"
Your endpoint took too long. Answer with a 2xx as soon as the request is verified and do the work afterwards.
"The channel's address resolves only to private or otherwise non-public addresses"
Sitejar posts only to public addresses. Expose the endpoint publicly, or route it through a public relay you control.
My signature check always fails
Compute the HMAC over the raw body as received, not over JSON you parsed and serialized again, and key it with the whole secret, whsec_ included. A lost secret cannot be shown again: remove the webhook and add it back to get a new one.
"A workspace can have 10 webhooks. Remove one first."
You are at the limit. One webhook can take several events, so endpoints that do the same job can often share one.
Sitejar webhooks FAQ
What events can Sitejar webhooks send?
scan.completed when a scan of a site finishes, score.dropped when the overall score falls 5 points or more against the previous completed scan, and finding.new_high when a scan finds new Confirmed High or Critical findings. A ping is sent only by the test button.
How do I verify a Sitejar webhook?
Read the Sitejar-Signature header, t=<unix seconds>,v1=<hex>. Compute HMAC-SHA256 of the timestamp, a full stop and the raw body, keyed with your whole signing secret, and compare it with v1 in constant time.
Does Sitejar retry failed webhook deliveries?
Yes. A failed delivery is retried after 1, 4, 9, 16 and 25 minutes, six attempts in all. After that you can send it again with Retry in the webhook's Deliveries list.
Can I get a webhook for one site only?
Yes. When you add the webhook, choose the site under Sites instead of Every site.
Do webhooks include the findings themselves?
No. Payloads carry ids, the host, scores, counts and a report link, never finding evidence or page content. Use the REST API with an API key to read findings.
Which plan includes webhooks?
Webhooks are on Business and above. The REST API and CI checks are on every plan, Free included.
What is the difference between a webhook and an alert channel?
A webhook here sends every event you subscribe to, for every site or one site. An alert channel posts only when a site's own alert rule fires. Alert channels can also be your own signed webhook url, set up in Settings, Alert channels.
Related integrations
Last updated .