Async & webhooks

Voor grote PDF’s, screenshots van volledige pagina’s of hoog volume, render je asynchron: plaats de taak in de wachtrij, ontvang onmiddellijk een id terug, en poll vervolgens of ontvang een ondertekende webhook.

# Enqueue

Voeg async: true (of een webhookUrl) toe aan elke render of screenshot aanvraag:

bash

curl https://api.mostlyrender.com/v1/renders \
  -H "Authorization: Bearer mr_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "tpl_abc",
    "output": "pdf",
    "async": true,
    "webhookUrl": "https://your.app/hooks/mostlyrender"
  }'

json

{ "id": "job_xyz789", "status": "queued" }

Het antwoord is 202 Accepted met een taak-id.

# Poll

bash

curl https://api.mostlyrender.com/v1/renders/job_xyz789 \
  -H "Authorization: Bearer mr_live_…"

json

{
  "id": "job_xyz789",
  "status": "done",
  "kind": "render",
  "result": { "id": "rnd_abc", "url": "https://img.mostlyrender.com/…/rnd_abc.pdf", "output": "pdf" },
  "error": null
}

status gaat queued → processing → done (of error). Wanneer done, bevat result de render { id, url, output }.

python

job = mr.render_async("tpl_abc", output="pdf", webhook_url="https://your.app/hooks/mostlyrender")
final = mr.wait_for_render(job["id"])
print(final["result"]["url"])

# Webhooks

Als je een webhookUrl doorgeeft, POSTed MostlyRender het taakresultaat daar wanneer deze klaar is:

json

{
  "id": "job_xyz789",
  "status": "done",
  "result": { "id": "rnd_abc", "url": "https://img.mostlyrender.com/…/rnd_abc.pdf", "output": "pdf" }
}

# Verifieer de handtekening

Elke webhook draagt een HMAC-SHA256-handtekening van de onverwerkte body in de x-mostlyrender-signature header, voorafgegaan door sha256=. Bereken deze opnieuw met je signeringssecret en vergelijk in constante tijd:

import crypto from 'node:crypto';

function verify(rawBody, header, secret) {
  const expected = 'sha256=' + crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
  return crypto.timingSafeEqual(Buffer.from(header), Buffer.from(expected));
}

Reageer met elke 2xx om te bevestigen. Aflevering wordt een paar keer opnieuw geprobeerd bij fouten; webhook-doelen zijn SSRF-beveiligd net als screenshot-URL’s.