Deploy hook: keep tracked pages fresh

The deploy hook lets your deploy pipeline tell Quillly that your site just changed. Quillly then reads your sitemap and re-checks your Site pages at once, instead of at its daily run. At the end, every deploy triggers that re-check on its own.

Before you start, you need:

• A Site pages section that tracks your sitemap. Site pages shows how to set one up.

• Access to your deploy pipeline, such as GitHub Actions, and a place in it to store secrets.

Set up the deploy hook#

1. Copy the deploy hook URL#

   Open Site pages and click Deploy hook. The dialog shows the Deploy hook URL, a curl command and a GitHub Actions step. The token is masked on screen, but clicking the URL or the curl block copies it in full.

   

2. Store the token as a secret#

   The token is the part of the URL after token=. Save it in your pipeline's secrets, for example as a GitHub Actions secret named QUILLLY_DEPLOY_TOKEN, rather than in your repository.

3. Call the hook after your deploy#

   Add the step from the dialog at the end of your deploy job. It looks like this, with your own website ID:

   yaml Copy

   - name: Notify Quillly of deploy
     run: |
       curl -X POST "https://quillly.com/api/ping/pages/<websiteId>?token=${{ secrets.QUILLLY_DEPLOY_TOKEN }}&delay=120"

   Any other pipeline works the same way, as long as it can send a POST. You can pass the token in a header instead of the URL:

   bash Copy

   curl -X POST "https://quillly.com/api/ping/pages/<websiteId>?delay=120" \
     -H "Authorization: Bearer $QUILLLY_DEPLOY_TOKEN"

4. Check that it ran#

   The call answers 202 at once, and the run happens in the background. In Site pages, new pages appear and changed pages show Submitted again.

   Open Site pages

What a run does#

Each run works like the daily run:

• It reads your sitemap and adds new pages, which then get a quality score.

• It sends new pages, and pages whose lastmod date changed, to IndexNow, up to 50 per run.

• It compares the content of up to 25 pages, starting with those checked longest ago, and sends the changed ones to IndexNow.

• It marks pages that left your sitemap as Left sitemap.

A run doesn't redo the quality check of a changed page. Click Quality check all in Site pages for that. It also sends nothing to Google, which reads your sitemap on its own schedule.

Parameters#

Send them in the query string or in a JSON body. When both have one, the query string wins.

Set delay to the time between your pipeline finishing and the new pages being live, including any CDN cache purge. If your pages go live in seconds, leave it out.

Responses and limits#

A call without delay starts a run at once and blocks further immediate calls for 120 seconds. A call with delay has no such limit: it replaces any run still waiting for the website, so ten quick deploys lead to one run.

Common questions#

Do I need the deploy hook?#

No. Quillly re-reads your sitemap every day at 05:00 UTC. The hook makes the re-check happen right after a deploy instead.

Is there a button for this in the dashboard?#

Yes. Refresh in Site pages starts the same run without a token. Only the website's owner can use it, once every 2 minutes.

Why did my call get 429?#

Another immediate run started less than 2 minutes before. Wait, or add delay to your call.

Related#

• Site pages: track and score the pages you already have: the pages the hook re-checks.

• Indexing: how your pages reach search engines: what happens after a page goes to IndexNow.

• Webhook publishing: the other direction, where Quillly calls your server when you publish.