Async & webhooks

Pour les grands PDF, les captures d’écran pleine page ou les grands volumes, effectuez le rendu asynchrone : mettez le travail en file d’attente, obtenez un identifiant immédiatement, puis consultez ou recevez un webhook signé.

# Enqueue

Ajoutez async: true (ou un webhookUrl) à n’importe quel render ou screenshot requête :

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" }

La réponse est 202 Accepted avec un identifiant de travail.

# 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 se déplace queued → processing → done (ou error). Quand done, result contient le rendu { 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

Si vous passez un webhookUrl, MostlyRender envoie le résultat du travail par POST quand il se termine :

json

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

# Vérifier la signature

Chaque webhook porte une signature HMAC-SHA256 du corps brut dans l’en-tête x-mostlyrender-signature, préfixé sha256=. Recalculez-le avec votre secret de signature et comparez en temps constant :

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));
}

Répondez avec un 2xx pour confirmer. La livraison est relancée quelques fois en cas d’échec ; les cibles des webhooks sont protégées par SSRF comme les URL de capture d’écran.