Integration
Webhooks
Verwalten Sie Webhooks für Echtzeit-Updates
Webhooks verbinden Output.Rocks mit externen Plattformen wie Powercloud, n8n, Binect, E-POSTBUSINESS oder kundeneigenen REST-Endpunkten. Sie werden genutzt, um Dokumente oder E-Mails für Folgeaktionen und Callbacks direkt zu übertragen, Statusänderungen zu empfangen oder Prozesse anzustoßen.
Einen Überblick dazu finden Sie auch im Use-Case E-Mail & Anhänge.
Diese Seite zeigt eine Liste aller Elemente, und darüber diverse Aktionen, die du ausführen kannst:
Webhook-Liste
Die Tabelle zeigt alle eingerichteten Webhooks inklusive Identifier, Typ und Mandantenkontext. Im Backend lassen sich über 30 vordefinierte Webhook-Typen auswählen, unter anderem SFTP-Uploads, Powercloud-spezifische Schnittstellen oder generische Custom-Endpoints.
ID, Identifier, Gruppen-Identifier, Aktiv ab, Aktiv, Typ
| ID | Identifier | Gruppen-Identifier | Aktiv ab | Aktiv | Typ |
|---|---|---|---|---|---|
| identifier_name | Null | Aktiv |
ID
Eindeutige Nummer zur internen Identifikation des Webhooks.
Identifier
Eindeutiger Name des Webhooks für Rendering und API-Aufrufe.
Eindeutiger Name für eine optionale Gruppierung von verwandten Webhookn. Elemente einer Gruppe werden gemeinsam verarbeitet und optionale Validatoren können dabei einzelne Elemente aktivieren oder ignorieren.
Aktiv ab
Startdatum eines Webhooks. Webhooks werden erst ab diesem Datum beim Rendern beachtet.
Aktiv
Schnellübersicht, ob das Webhook derzeit freigegeben ist. Deaktivierte Elemente behalten ihre Historie, werden aber nicht mehr automatisch verwendet.
Typ
Der Dateneintrag des Webhooks. Kann Text, Zahlen, Bedingungen oder andere Daten enthalten, die in Vorlagen verwendet werden.
Webhook-Zuordnung über POST Rendering Requests
Der hier hinterlegte identifier des Webhooks muss in Ihrem API-POST Request zum Rendern enthalten sein.
Dafür existiert dort der key "webhook": "identifier". Ohne diesen bleibt die Liste der zu überprüfenden Webhooks leer, es gibt kein globales Testen aller Webhooks.
Die Spalte Typ benennt die genaue Art des Webhooks, als Beispiele Dokument- und E-Mail-Webhooks (z.B. sftp-email, sharepoint-document, powercloud-ouauth2-document). Ältere Powercloud-Typen wie powercloud-document bleiben als Bestandskonfigurationen sichtbar. Darüber hinaus existiert das Feld Priorität (1 = höchster Rang), um parallele Integrationen geordnet ablaufen zu lassen.
Mandant, Standard für Umgebungs-Mandanten
| Umgebungs-Mandant | Standard für Umgebungs-Mandanten | Benutzerdefinierte ID | Farbe |
|---|---|---|---|
| (1880) Submarke 1 | NO | Null | |
| Null | YES | <<payload.value>> |
Zugeordneter Mandant des/der Webhook. Ermöglicht Mandanten-spezifische Konfiguration.
Kennzeichnet Webhook als Standard und vererbt (verfügbar) für alle Umgebungs-Mandanten.
Optionale benutzerdefinierte Kennung nach dem Rendering für externe Systeme. Wird als Referenzen des/der Webhook bei Callbacks übergeben und beherrscht Vorlagen-Syntax inkl. Zugriff auf Payload-Daten.
Visuelle Kennzeichnung für schnelle Identifikation des/der Webhook. Vor allem nützlich für Dashboard-Statistiken und Charts.
Nutzen Sie Mandanten-Zuweisungen, um z.B. Stadtwerke-spezifische Webhooks getrennt von allgemeinen Konzern-Integrationen zu verwalten.
Erstellt am, Aktualisiert am
| Validatoren | Pausiert | Aktiv | Erstellt am | Aktualisiert am |
|---|---|---|---|---|
| Null | NO | Ja | ||
| missing_street | YES | Nein |
Zugewiesene Validierungsregeln für das Webhook. Prüfen Ihre Bedingungen vor der Verarbeitung und aktivieren/deaktivieren das Rendering entsprechend.
Temporäre Deaktivierung des Webhooks. Pausierte Elemente werden nicht verarbeitet.
Aktivierungsstatus des Webhooks. Nur aktive Elemente werden beim Rendern berücksichtigt.
Erstellt am
Zeitstempel der Webhook-Erstellung.
Aktualisiert am
Zeitstempel der letzten Änderung. Zeigt wann Webhook-Konfiguration zuletzt bearbeitet wurde.
Die Webhook-Liste zeigt standardmäßig die neuesten Einträge zuerst (Erstellt am aufsteigend mit Sortierpfeil). Mit den Spaltenaktionen lässt sich dies jederzeit anpassen.
Webhook erstellen
Die Schaltfläche Webhook erstellen öffnet geführte Einstiegskarten für die häufigsten Integrationen. SFTP, SharePoint und DropBox führen durch Upload-Ziel, Upload-Format und Details. Binect und E-POSTBUSINESS konfigurieren den physischen Druckversand. Powercloud öffnet einen eigenen Dialog, in dem zuerst der Anwendungsfall, danach bei Bedarf der Subtyp und anschließend Dokument oder E-Mail gewählt wird.
SFTP & Cloud Storage
SFTP Document/Email Upload, DropBox, SharePoint.
Druckversand
Binect und E-POSTBUSINESS für Dokumente oder PDF-Anhänge.
Powercloud (pc.retail)
Archive Upload, Custom API, User Interaction, Tariff Service.
Custom & Automations
n8n, Custom Document Webhook, Custom Email Webhook, Prerender APIs.
Wählen Sie den passenden Einstieg, um vorkonfigurierte Felder, Header und Auth-Optionen automatisch zu erhalten.
Der Tab Configuration passt sich vollständig an den gewählten Webhook-Typ an. Häufig stehen Felder für URL, Credentials/Keys sowie eine JSON-Konfiguration bereit; zusätzliche Inputs (z.B. Upload-Optionen, OAuth2-Felder oder SFTP-spezifische Angaben) erscheinen automatisch.
SFTP, SharePoint und DropBox bieten im Dialog einen Test-Upload. Powercloud-OAuth2-, Binect- und E-POSTBUSINESS-Webhooks bieten stattdessen API-Authentifizierung testen; dabei wird nur die Anmeldung beim jeweiligen Dienst geprüft, ohne einen Webhook auszuführen oder Zugangsdaten dauerhaft zu speichern.
Powercloud-Erstellung
Der Powercloud-Dialog bildet die produktiv nutzbaren OAuth2- und Tariff-Service-Typen ab:
| Auswahl | Dokument | |
|---|---|---|
| powercloud Archive Upload | powercloud-ouauth2-document | powercloud-ouauth2-email |
| powercloud Custom API | powercloud-custom-ouauth2-document | powercloud-custom-ouauth2-email |
| User Interaction: Invalid data | powercloud-invalid-user-interaction-oauth2-document | powercloud-invalid-user-interaction-oauth2-email |
| User Interaction: Blocked processes | powercloud-blocked-user-interaction-oauth2-document | powercloud-blocked-user-interaction-oauth2-email |
| User Interaction: Email bounce | nicht verfügbar | powercloud-bounced-user-interaction-oauth2-email |
| powercloud Tariff Service | prerender-powercloud-tariff-service-module-information-document | prerender-powercloud-tariff-service-module-information-email |
Für Powercloud Archive/Custom E-Mail-Webhooks wird zusätzlich das E-Mail-Format gewählt: vollständige .eml, nur HTML-Inhalt, nur Anhänge oder HTML-Inhalt mit Anhängen. Ältere Powercloud-Typen wie powercloud-document, powercloud-email, powercloud-invalid-user-interaction-document, powercloud-invalid-user-interaction-email, powercloud-blocked-user-interaction-document, powercloud-blocked-user-interaction-email, powercloud-bounced-user-interaction-email und powercloud-powerdata-email können nicht neu über den geführten Dialog erstellt werden. In der Bearbeitung sind sie read-only; nur Aktiv kann geändert werden.
Druckdienstleister-Webhooks
Binect und E-POSTBUSINESS sind Webhook-Typen für physischen Briefversand. Sie erzeugen nach dem Rendering eigene Drucksendungen, die unter Druckversand überwacht werden.
| Auswahl | Dokument | Hinweis | |
|---|---|---|---|
| Binect | binect-document | binect-email | Versendet PDF-Dokumente oder PDF-Anhänge über die Binect-Sandbox bzw. Produktion. |
| E-POSTBUSINESS | epostbusiness-document | epostbusiness-email | Nutzt im Testmodus keinen physischen Versand; Produktion löst echten Briefversand aus. |
Beide Anbieter akzeptieren nur PDF-Dateien. Bei E-Mail-Webhooks werden alle PDF-Anhänge des E-Mail-Prozesses als einzelne Drucksendungen angelegt; andere Anhangsformate werden nicht als Brief versendet.
Formularstruktur
Aktions-Buttons zum Speichern und Verwalten der Webhook-Konfiguration.
Verwenden Sie "Erstellen und weiteres Element hinzufügen" für effizientes Batch-Erstellen mehrerer Elemente.
Details-Tab
Dieser Tab ist bei allen Webhook-Typen identisch und definiert Identifier, Priorität und Aktivierungslogik.
Eindeutige Kennung für dieses/r Webhook zur programmatischen Verwendung, Einbindung in Vorlagen, Lookups und API-Zugriff.
Identifiers sollten 'snake_case' sein, also klein geschrieben und Unterstriche verwenden, z.B. 'kunde_name' oder 'rechnung_nummer'.
Eindeutige Kennung für die Gruppierung und Organisation von Webhookn.
Elemente einer Gruppe werden gemeinsam verarbeitet und optionale Validatoren können dabei einzelne Elemente aktivieren oder ignorieren.
Gruppen-Identifier sind optional und können bei Bedarf leer gelassen werden.
Gruppen-Identifier sollten 'snake_case' sein, also klein geschrieben und Unterstriche verwenden, z.B. 'kunde_name' oder 'rechnung_nummer'.
Ganzzahliger Rang. 1 bedeutet höchste Priorität, höhere Zahlen laufen nachrangig.
Trigger-Zeitpunkte im Renderprozess
Vor der Prioritätssortierung gibt es drei Trigger-Zeitpunkte, die durch die Art des Webhooks bestimmt werden: (1) Prerender-Hooks direkt nach Start noch vor Validation/Rendering, (2) Post-render Hook-Schleife unmittelbar nach render_template mit einem fertigen Dokument, (3) E-Mail-Workflows nach send_email sowie den Statusübergängen delivered oder bounced.
Innerhalb dieser Trigger-Zeitpunkte werden die zugeordneten Hooks nach ihrer Priorität ausgeführt.
Bedingte Logik für die Auswahl des Elements basierend auf Payload-JSON-Daten. Das Element wird angesprochen, wenn der Gruppen-Identifier mit dem Request übereinstimmt. Es wird aber nur gerendert, wenn die Bedingung erfüllt (true) ist.
Startdatum des Webhooks. Webhooke werden erst ab diesem Datum beim Rendern beachtet.
Die Aktiv-Checkbox ermöglicht eine sofortige De-/Aktivierung unabhängig vom Datum.
Vor-Terminierung: Mit diesem Feld können Webhooke vor-terminiert werden. Setzen Sie ein zukünftiges Datum, um das Element automatisch ab diesem Zeitpunkt zu aktivieren.
Mehrere Elemente mit gleichem Identifier: unterschiedliches 'Aktiv ab' staffelt die Version; bei einer Anfrage gilt das aktive Element mit dem spätesten Aktiv ab (nicht Erstell- oder Änderungsdatum).
Konfigurations-Tab
Test nutzt die Binect-Sandbox. Produktion verschickt echte Briefe bei Workflow-Ausführung.
Login-Name des Binect-Zugangs. Kann direkt eingetragen oder per Zugangsdaten-Platzhalter geladen werden.
Passwort des Binect-Zugangs. Am besten als verschlüsselte Zugangsdaten speichern und hier referenzieren.
Aktiviert einseitigen Druck. Deaktiviert bedeutet Duplex, also beidseitiger Druck.
Aktivieren, wenn das PDF farbig gedruckt werden soll. Sonst erfolgt Schwarzweißdruck.
DIN lang ist der Standard für normale Briefe; C4 eignet sich für größere Sendungen.
Automatisch lässt Binect die passende Frankierung wählen. DV-Frankierung nur nutzen, wenn Konto und Dokument dafür vorbereitet sind.
Meist automatisch lassen. Nur festlegen, wenn Vertrag oder Versandprodukt ein Land verlangt.
Standardbrief für normalen Versand. Premiumadress und Einschreiben nur nutzen, wenn sie im Binect-Konto freigeschaltet sind.
Kontext-Aktionen
Aktions-Dropdown
Aktions-Dropdown
Klicken Sie auf das Drei-Punkte-Menü am Ende jeder Zeile für Aktionen mit dem jeweiligen Webhook.
Testen
Öffnet eine Webhook-Testumgebung zum lokalen Rendern mit bearbeitbaren Validatoren und JSON-Testdaten.
Webhook herunterladen
Lädt die Quell-Datei des Webhook auf Ihren Computer herunter.
Anzeigen
Öffnet eine reine Detailansicht der kompletten Meta-Informationen und Einstellungen des Webhook.
Ändern
Öffnet das Bearbeitungsformular für alle Einstellungen und den Upload einer neuen Webhook-Version.
Löschen
Entfernt das Webhook dauerhaft aus dem System. Diese Aktion kann nicht rückgängig gemacht werden.
Die Dropdown-Aktionen enthalten Anzeigen und Ändern. Löschvorgänge laufen über das separate Bestätigungsmodal, damit produktive Integrationen nicht versehentlich entfernt werden.
Filter
- Filtern öffnet das Modal mit Suchkriterien wie Identifier, Typ oder Mandant.
- Zurücksetzen setzt alle Kriterien zurück und schließt das Modal.
- Anwenden übernimmt die Auswahl, aktualisiert die Tabelle sofort und schließt den Dialog.
Das Filter-Modal übernimmt die Standard-Iconographie aus dem Backend (fa-filter, fa-close, fa-check) und zeigt den aktuellen Status in der Titelleiste.
Spalten konfigurieren
Passen Sie die Anzeige der Webhook-Liste für bessere Übersichtlichkeit an. Spalten können per Drag-and-Drop neu angeordnet und über Checkboxen ein-/ausgeblendet werden.
Für mich anwenden : Spalten-Konfiguration wird nur für Ihren Account gespeichert und beeinflusst andere Benutzer nicht.
Als Standard anwenden : Konfiguration wird für alle Benutzer der Instanz übernommen und als neue Standard-Ansicht gesetzt.
Das Konfigurationsmodal bietet drei Speicherpfade:
- Für mich anwenden – persönliche Ansicht.
- Als Standard anwenden – gesamte Umgebung nutzt diese Sicht.
- Auf Standard zurücksetzen – ursprüngliche Spaltenauswahl reaktivieren.
Die Vorauswahl enthält Identifier, Typ und Status. Ergänzen Sie bei Bedarf zusätzliche Felder wie Mandant oder Priorität, um Fehleranalysen zu beschleunigen.
Weitere Bedienelemente
- Pagination zeigt im Footer die Anzahl der Treffer (z.B. „2 Ergebnisse“). Bei mehr Seiten erscheinen Zurück/Weiter-Buttons.
- Löschbestätigung:
modal-deletefordert eine zusätzliche Bestätigung inklusive Token, bevor ein Webhook endgültig entfernt wird. - Hidden Delete Form sorgt dafür, dass Löschanfragen signiert und serverseitig geprüft werden.