PDF asynchron rendern und den Webhook prüfen mit Ruby

Was Sie brauchen

• Einen API-Key. Legen Sie ihn in der App unter API-Schlüssel an und exportieren Sie ihn als FORMFEED_API_KEY. Zum Ausprobieren ist ein Test-Key (ff_test_…) richtig. Siehe Quickstart.
• Ruby. Sie brauchen Ruby 3; das Programm nutzt net/http und json aus der Standardbibliothek.
• Die Vorlage. revenue-report aus dem Berichtsbeispiel und dessen data.json neben dem Programm.
• Ein Secret. 16 bis 200 zufällige Zeichen in FORMFEED_WEBHOOK_SECRET, beiden Programmen bekannt. Es signiert die Zustellungen dieses Renderings, Retries eingeschlossen.
• Eine öffentliche URL. Ersetzen Sie https://example.com/hooks/formfeed durch Ihren Endpunkt. Während der Entwicklung leitet formfeed listen Zustellungen ohne Tunnel an localhost weiter.

Das Programm

Die Anfrage nennt die Vorlage, schaltet auf mode: "async" und sagt, wohin gemeldet wird. Die Antwort kommt sofort, mit dem Status queued.

require "json"
require "net/http"

data = JSON.parse(File.read("data.json"))
body = {
  template: "revenue-report",
  data: data,
  mode: "async",
  webhook_url: "https://example.com/hooks/formfeed",
  webhook_secret: ENV.fetch("FORMFEED_WEBHOOK_SECRET"),
}
auth = { "Authorization" => "Bearer #{ENV.fetch("FORMFEED_API_KEY")}" }

response = Net::HTTP.post(
  URI("https://api-eu.formfeed.dev/v1/renders"),
  JSON.generate(body),
  auth.merge("Content-Type" => "application/json")
)
render = JSON.parse(response.body)

# every error is a problem document (RFC 9457) with a title and a detail
abort "#{render["title"]}: #{render["detail"]}" unless response.is_a?(Net::HTTPSuccess)

puts "#{render["id"]} #{render["status"]}" # queued: the webhook reports the rest

Ausführen

Es gibt die ID des Renderings und queued aus. Wenige Sekunden später erhält Ihr Endpunkt render.completed mit dem vollständigen Rendering samt download_url, oder render.failed mit dem Grund.

export FORMFEED_API_KEY=ff_test_...
export FORMFEED_WEBHOOK_SECRET=$(openssl rand -hex 24)
ruby render.rb

Was an Ruby besonders ist

• Hashes werden zu JSON. Symbol-Keys sind in Ordnung: JSON.generate schreibt sie als Strings, und die snake_case-Namen der API sind ohnehin idiomatisches Ruby.
• abort mit dem Problem. Ein Problem-Dokument enthält title und detail; das Programm gibt beides aus und endet mit Status 1.
• In Rails. Legen Sie den Aufruf in einen Job (Active Job, Sidekiq), nicht in den Request-Zyklus: Ein synchrones Rendering antwortet, wenn das PDF fertig ist, und das kann bis zu 60 Sekunden dauern, bevor die API mit 202 antwortet und im Hintergrund fertig rendert.

Der Empfänger

Er lauscht auf Port 8080, liest den rohen Body, prüft Signatur und Alter des Zeitstempels und sieht sich erst dann das JSON an. Eine Zustellung, die die Prüfung nicht besteht, erhält 401.

# gem install sinatra rackup puma && ruby hook.rb
require "json"
require "openssl"
require "sinatra"

set :bind, "0.0.0.0"
set :port, 8080
SECRET = ENV.fetch("FORMFEED_WEBHOOK_SECRET")

post "/hooks/formfeed" do
  # the signature covers the bytes on the wire: read the raw body, never re-serialised JSON
  body = request.body.read

  # Webhook-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of "t.body">
  parts = request.env.fetch("HTTP_WEBHOOK_SIGNATURE", "").split(",").select { |part| part.include?("=") }
  signature = parts.to_h { |part| part.strip.split("=", 2) }
  timestamp = signature["t"].to_i
  expected = OpenSSL::HMAC.hexdigest("SHA256", SECRET, "#{timestamp}.#{body}")
  given = signature["v1"].to_s.downcase

  fresh = (Time.now.to_i - timestamp).abs <= 300
  halt 401 unless fresh && given.bytesize == expected.bytesize && OpenSSL.fixed_length_secure_compare(expected, given)

  event = JSON.parse(body)
  case event["type"]
  when "render.completed" then puts "done #{event["data"]["id"]} #{event["data"]["download_url"]}"
  when "render.failed" then puts "failed #{event["data"]["id"]}"
  end
  status 204
end

Empfänger starten

gem install sinatra rackup puma
FORMFEED_WEBHOOK_SECRET=… ruby hook.rb

Prüfen in Ruby

• Konstante Zeit. OpenSSL.fixed_length_secure_compare braucht gleiche Längen, daher vorher der bytesize-Vergleich. In Rails erledigt ActiveSupport::SecurityUtils.secure_compare beides.
• Roher Body in Rails. Nutzen Sie request.raw_post. params ist das geparste JSON und hat nicht mehr die Bytes, über die die Signatur läuft.

Was ankommt

Ein POST mit Webhook-Signature: t=<Unix-Sekunden>,v1=<hex>; das Hex ist HMAC-SHA256 über t, einen Punkt und den rohen Body, mit Ihrem Secret als Schlüssel, genau so, wie Sie es haben, als UTF-8-Bytes: das webhook_secret, das Sie gesendet haben, oder die ganze whsec_…-Zeichenkette eines registrierten Endpunkts samt Präfix. Jeder Versuch wird mit eigenem t neu signiert. Webhook-Id bleibt über Retries gleich und ist damit Ihr Schlüssel zum Deduplizieren. data ist das Rendering, wie GET /renders/{id} es liefert:

{
  "id": "evt_5b0c8e6f2d4a4c3e9b1a7f6e5d4c3b2a",
  "type": "render.completed",
  "created_at": "2026-09-18T10:42:00Z",
  "workspace_id": "3a6f…",
  "data": {
    "id": "rnd_7da09ab6cd9946b798c187c2a9350852",
    "status": "succeeded",
    "download_url": "https://cdn.formfeed.dev/o/eu/…/document.pdf?exp=…&sig=…",
    "page_count": 2,
    "units": 1,
    …
  }
}

Retries, und was Ihr Endpunkt leisten muss

• Schnell antworten. Eine Zustellung gelingt mit einem 2xx innerhalb von 10 Sekunden. Speichern Sie das Event und erledigen Sie die Arbeit danach.
• Retries. Alles andere, auch eine Weiterleitung, wird nach 1 Minute, 5 Minuten, 30 Minuten, 2 Stunden und 12 Stunden wiederholt: insgesamt sechs Versuche über etwa 14 Stunden und 40 Minuten. Dasselbe Event kann also zweimal ankommen: Deduplizieren Sie über Webhook-Id.
• Ohne Secret. Eine webhook_url ohne webhook_secret wird unsigniert zugestellt. Für signierte Zustellungen aller Renderings registrieren Sie einmal einen Endpunkt in der App oder über POST /webhooks; er erhält ein eigenes Secret.
• Lokal ausprobieren. formfeed listen --forward-to http://localhost:8080/hooks/formfeed leitet die Events Ihrer Test-Renderings an Ihren Rechner weiter, signiert mit dem eigenen Secret der Session statt mit webhook_secret: Starten Sie den Empfänger mit diesem, das formfeed listen --print-secret ausgibt (vor der Session aufrufen, denn es beendet eine laufende). formfeed trigger render.completed --template revenue-report erzeugt ein echtes Test-Rendering, dessen Event Sie ankommen sehen. Der Schlüssel braucht den Scope webhook:listen. Siehe Webhooks lokal entwickeln.

Wenn die API nein sagt

• Eine Form für jeden Fehler. Fehler sind Problem-Dokumente (RFC 9457) mit type, title, status, detail, einem stabilen code und der request_id, die Sie dem Support nennen; die type-URL führt zu einer Seite über diesen Fehler. Die Liste steht in der Fehlerreferenz.
• Die üblichen. 401 unauthorized bei fehlendem oder widerrufenem Schlüssel, 404 template_not_found bei falschem Vorlagennamen, 422 template_runtime_error, wenn die Vorlage an den Daten scheitert, 429 rate_limited über den Anfragen pro Sekunde des Tarifs, 402 quota_exceeded, wenn die Einheiten des Free-Tarifs verbraucht sind (ein bezahlter Tarif rechnet weitere Einheiten ab, bis zu seiner Obergrenze).
• Sicher wiederholen. Senden Sie beim POST einen Idempotency-Key-Header und wiederholen Sie die Anfrage mit demselben Schlüssel, wenn Sie nicht wissen, ob der erste Versuch ankam: 24 Stunden lang liefert der Schlüssel die erste Antwort, statt erneut zu rendern und zu berechnen. Gespeichert wird die Antwort, sobald der erste Versuch beantwortet ist; wiederholen Sie also nicht, solange er noch laufen kann. Auch Probleme unter 500 werden gespeichert, eine korrigierte Anfrage braucht deshalb einen neuen Schlüssel.

Die Aufgabe um dieses Programm

Dieser Guide ist ein Programm. Was die Aufgabe darum herum braucht, von der Vorlage bis zu Limits und Preis, steht auf der Seite Report-PDFs erzeugen.

Weitere Guides für Ruby

• PDF-Rechnung aus JSON erzeugen mit Ruby
• ZUGFeRD-E-Rechnung erstellen mit Ruby
• HTML in PDF umwandeln mit Ruby
• Open-Graph-Bilder erzeugen mit Ruby
• PDFs aus einer CSV erzeugen mit Ruby
• PDFs zusammenfügen und mit Passwort schützen mit Ruby

FAQ

Kann ich pollen, statt einen Webhook zu empfangen?

Ja: GET /renders/{id}, bis der Status succeeded oder failed ist; die SDKs haben dafür waitFor und wait_for. Ein Webhook spart die Anfragen und meldet sich früher. Siehe Async und Batch.

Warum muss der rohe Body verwendet werden?

Die Signatur läuft über die Bytes auf der Leitung. JSON zu parsen und neu zu serialisieren kann Schlüssel umsortieren, Zahlenformate ändern oder Zeichen anders maskieren, und der HMAC dieses Textes passt dann nicht mehr.

Wozu dient die Fünf-Minuten-Toleranz?

Sie verhindert, dass eine abgefangene Zustellung später erneut eingespielt wird. Sie bedeutet auch, dass die Uhr Ihres Servers ungefähr stimmen muss.

Asynchron rendern mit Webhook in anderen Sprachen

• Node.js (TypeScript)
• Python
• PHP
• Go
• C# (.NET)
• Java