Integrationen: ausgehende Webhooks
Senden Sie Workspace-Events (Post veröffentlicht, Konto getrennt...) als signierte HTTPS-Anfragen an Ihre eigenen Systeme.
Einstellungen → Integrationen (Adresse /app/settings/integrations) sendet Ereignisse von diesem Arbeitsbereich an eine URL von Ihnen, zum Beispiel ein Automatisierungstool (Zapier, Make, n8n) oder Ihren eigenen Server. Nur Inhaber und Admin können das sehen und ändern.
Schritt für Schritt: einen Endpunkt hinzufügen
- Einstellungen → Integrationen.
- Geben Sie unter Endpunkt-URL Ihre Endpunkt-URL ein, zum Beispiel
https://your-system.example.com/omnibrand-hook. Sie muss https verwenden und im öffentlichen Internet erreichbar sein; andernfalls sagt eine rote Zeile, was nicht stimmt ("Die Endpunktadresse muss mit https:// beginnen. Einfaches http:// wird nicht akzeptiert.", oder dass sie aus dem Internet nicht erreichbar ist). - Wählen Sie unter Ereignisse die Ereignisse aus, die dieser Endpunkt empfängt. Jedes Kästchen hat eine verständliche Beschreibung und den Namen des Ereignisses, zum Beispiel
post.published("Ein Beitrag wurde veröffentlicht"),post.failed,social_account.token_expiredodersocial_account.disconnected; Alle Ereignisse, auch später hinzugefügte ist*.workspace.createdundinvitation.acceptedsind ebenfalls dabei. Wählen Sie mindestens eines aus, sonst sagt das Formular "Wählen Sie mindestens ein Ereignis aus." - Klicken Sie auf Endpunkt hinzufügen.
- Signatur-Secret (jetzt kopieren – wird nur einmal angezeigt): erscheint mit dem Secret über dem Formular; die Seite scrollt nach oben dorthin, sodass Sie es auch auf einem Handy sehen. Wenn der Endpunkt abgelehnt wird, erscheint die rote Meldung an derselben Stelle, und die Seite scrollt dorthin. Kopieren Sie das Secret jetzt in Ihr empfangendes System; OmniBrand zeigt es nie wieder an (nur seine letzten vier Zeichen). Secret kopieren daneben kopiert es für Sie.
- Klicken Sie beim Endpunkt auf Test senden. Sie sehen ✓ zugestellt mit dem HTTP-Status, den Ihr Server zurückgegeben hat. Wenn es fehlschlägt, sehen Sie "Nicht zugestellt: Ihr Server hat mit [status] geantwortet." mit dem Hinweis, was zu beheben ist, zum Beispiel bei 405 Methode nicht erlaubt "Er muss POST-Anfragen an dieser Adresse annehmen.", bei 404 Nicht gefunden "Unter dieser Adresse antwortet nichts. Prüfen Sie die URL.", bei einer Weiterleitung "Er hat auf eine andere Adresse weitergeleitet, und Webhooks folgen nie Weiterleitungen. Registrieren Sie stattdessen die endgültige URL."; oder, wenn der Server gar nicht erreichbar war, "Nicht zugestellt: Ihr Server konnte nicht erreicht werden ([Grund]). Prüfen Sie die URL und ob der Server online ist." Ein Link So funktionieren Webhooks öffnet diesen Artikel.
Jeder Endpunkt
- Die URL und ein Abzeichen aktiv oder deaktiviert.
- „Ereignisse: … · Schlüssel ••••1234“, jedes Ereignis mit seiner Beschreibung (zum Beispiel „Ein Beitrag wurde veröffentlicht“), dazu „· N aufeinanderfolgende Fehlschläge“, wenn Zustellversuche scheitern, und „· N warten auf einen neuen Versuch“, solange Ereignisse auf ihren nächsten Versuch warten.
- Eine rote Zeile „N fehlgeschlagene Zustellungen – öffnen Sie den Zustellverlauf, um sie erneut zu senden.“, wenn für Ereignisse keine weiteren Versuche mehr erfolgen (siehe Zustellverlauf und erneute Zustellung unten).
- Der Aktiviert / Deaktiviert pausiert oder setzt die Lieferungen fort. Während die Änderung gespeichert wird, steht auf der Karte "Funktioniert..." und der Test senden und Löschen wartet; wenn der Wechsel oder Löschen fehlschlägt, erscheint der Grund rot am unteren Rand der Karte des Endpunkts, und die Seite scrollt dorthin.
- Test senden sendet einmalig ein Ereignis namens
webhook.test(es wird nicht wiederholt und nicht im Verlauf gespeichert). - Zustellverlauf öffnet die letzten Zustellungen des Endpunkts (die Schaltfläche Zustellverlauf ausblenden schließt sie wieder).
- Löschen fragt "Webhook an (Adresse) löschen? Ereignisse werden sofort nicht mehr an ihn gesendet, und sein Signatur-Secret ist endgültig weg. Um ihn stattdessen zu pausieren, schalten Sie seinen Schalter aus." Das Fenster heißt Webhook löschen?; klicken Sie auf Löschen, um den Endpunkt sofort zu entfernen, oder auf Abbrechen, um ihn zu behalten.
Was Ihr Server empfängt
Ein POST mit JSON-Body: id (die ID des Ereignisses – verwenden Sie sie, um Duplikate zu ignorieren), event (zum Beispiel post.published), occurredAt und data (die Details des Ereignisses). Header:
X-OmniBrand-Signature:sha256=gefolgt vom HMAC-SHA256 des Rohkörpers, mit Ihrem Signiergeheimnis.X-OmniBrand-TimestampundX-OmniBrand-Signature-V2: Das HMAC-SHA256 mit Zeitstempel, Punkt und Korpus – verwenden Sie es, um alte Wiederholungen abzulehnen.
Antworten Sie innerhalb von 5 Sekunden mit einem beliebigen 2xx-Status.
Wiederholungen: wie lange OmniBrand es weiter versucht
Jedes Ereignis wird vor dem Senden gespeichert, sodass nichts verloren geht, wenn Ihr Server – oder unserer – neu startet. Antwortet Ihr Server nicht innerhalb von 5 Sekunden mit einem 2xx-Status (ein Fehler, eine Zeitüberschreitung, eine Weiterleitung, jede Antwort außer 2xx), wird das Ereignis nach etwa 1 Minute, 5 Minuten, 15 Minuten, 30 Minuten, 1 Stunde, 2 Stunden, 4 Stunden, 8 Stunden und 12 Stunden erneut gesendet – 10 Versuche in etwa 28 Stunden. Jede Wartezeit schwankt um bis zu 20 %, damit nicht alle Wiederholungen gleichzeitig eintreffen. Da eine Wiederholung nach einem späteren Ereignis ankommen kann, verwenden Sie id, um Duplikate zu ignorieren, und occurredAt, um Ereignisse zu ordnen.
Scheitern alle 10 Versuche, wird die Zustellung als Fehlgeschlagen markiert und bleibt 30 Tage im Verlauf, wo Sie sie erneut senden können.
Zustellverlauf und erneute Zustellung
- Klicken Sie am Endpunkt auf Zustellverlauf. Letzte Zustellungen listet die letzten 30 Tage auf, die neuesten zuerst.
- Jede Zeile zeigt ein Status-Abzeichen – Zugestellt, Wird wiederholt oder Fehlgeschlagen –, den Ereignisnamen, den Zeitpunkt, „Versuch N von 10“, bei Wird wiederholt die Zeit des „nächsten Versuchs“ und bei einer nicht erfolgreichen Zustellung „Letzte Antwort:“ mit der Antwort Ihres Servers (zum Beispiel „HTTP 503“ oder „No answer within 5 s“).
- Haken Nur fehlgeschlagene um die fehlgeschlagenen zu sehen; Ältere anzeigen Ladungen mehr an. Bei keiner steht da: "Keine fehlgeschlagenen Lieferungen in den letzten 30 Tagen. Lieferungen, die noch erneut versucht werden, werden nicht als fehlgeschlagen gezählt." (Ein Wird wiederholt ist noch nicht fehlgeschlagen).
- Um eine Zustellung erneut zu senden, klicken Sie in ihrer Zeile auf Erneut zustellen. Sie wird sofort gesendet: Sie sehen „Zugestellt.“ oder „Noch nicht zugestellt (Antwort). Es wird automatisch erneut versucht.“ – eine erneut gesendete Zustellung beginnt wieder mit 10 Versuchen.
- Um nach der Reparatur Ihres Servers alle erneut zu senden, klicken Sie auf Alle fehlgeschlagenen erneut zustellen (sichtbar, wenn es fehlgeschlagene Zustellungen gibt). Sie sehen „N fehlgeschlagene Zustellungen stehen in der Warteschlange und werden innerhalb einer Minute verschickt.“
Für eine erneute Zustellung muss der Endpunkt eingeschaltet sein; solange er Deaktiviert ist, warten die Schaltflächen, und der Verlauf zeigt „Dieser Endpunkt ist deaktiviert. Schalten Sie ihn ein, um erneut zuzustellen.“ Ereignisse, die eintreffen, während ein Endpunkt deaktiviert ist, werden weder gesendet noch gespeichert.
Wenn etwas schiefgeht
- Weiterleitungen werden nie gefolgt; registrieren Sie die letzte URL. Wenn Ihre URL weitergeleitet wird, sagt der Test: "Nicht zugestellt: Ihr Server hat 301 Permanent verschoben. Er wurde auf eine andere Adresse weitergeleitet, und Webhooks folgen nie auf Weiterleitungen. Registrieren Sie stattdessen die letzte URL." (mit dem Status, den Ihr Server gesendet hat).
- Ist jeder Versuch an einen Endpunkt einen ganzen Tag lang gescheitert (mindestens 20 Versuche in Folge), wird der Endpunkt automatisch deaktiviert und die Administratoren werden benachrichtigt. Seine wartenden Zustellungen werden als Fehlgeschlagen markiert. Reparieren Sie den Empfänger, stellen Sie den Schalter wieder auf Aktiviert, öffnen Sie dann den Zustellverlauf und klicken Sie auf Alle fehlgeschlagenen erneut zustellen.
API-Zugang (für Entwickler)
Unten auf der Seite steht die Karte API-Zugang (für Entwickler): "Verbinden Sie OmniBrand mit Ihren eigenen Systemen, Zapier oder Make, um automatisch Beiträge zu erstellen, Kontakte hinzuzufügen oder Analysen abzurufen." In den Tarifen Agency und Enterprise enthält sie Ihre Schlüssel für die öffentliche API (siehe API-Zugang). In anderen Tarifen steht dort "API-Zugang ist im Tarif Agency enthalten." mit dem Link Tarife ansehen. Die Webhooks auf dieser Seite funktionieren in jedem Tarif.
Gut zu wissen
- Ein Endpunkt empfängt nur die Ereignisse dieses Arbeitsbereichs sowie kontoweite Ereignisse (Abrechnungs- und Kontoereignisse).
- Der Arbeitsbereich, in dem Sie sich befinden, wenn Sie den Endpunkt hinzufügen, ist der, zu dem er gehört.