Dokumentation

Webhooks

Webhooks ermöglichen asynchrone Benachrichtigungen, wenn Ihre Generierungsaufgaben abgeschlossen sind. Anstatt die API nach Ergebnissen abzufragen, geben Sie eine Webhook-URL an, um POST-Anfragen mit Generierungsergebnissen zu erhalten.

Verwendung von Webhooks

Fügen Sie den Parameter {code} zu Ihrer Generierungsanfrage hinzu. Wenn die Aufgabe abgeschlossen ist (oder fehlschlägt), senden wir eine POST-Anfrage an Ihren Endpunkt:

{
  "type": "text-to-image",
  "model": "flux-dev",
  "prompt": "A beautiful sunset over mountains",
  "webhook_url": "https://your-app.com/webhooks/renderful"
}

Webhook-Payload

Ihr Endpunkt erhält eine POST-Anfrage mit der folgenden JSON-Payload:

{
  "event": "generation.completed",
  "data": {
    "id": "gen_abc123",
    "status": "completed",
    "model": "flux-dev",
    "outputs": ["https://..."],
    "created_at": "2024-01-15T10:30:00Z",
    "completed_at": "2024-01-15T10:30:15Z"
  }
}