Webhooks - Dokumentation - Meta for Developers

Übersicht

Webhooks ermöglichen es Apps mit benutzerdefinierter Integration, Events in Workplace zu abonnieren und Updates in Echtzeit zu erhalten. Wenn eine Änderung in Workplace auftritt, wird für jede App mit benutzerdefinierter Integration, die das entsprechende Webhook-Thema abonniert hat, eine HTTPS POST-Anfrage an eine Rückruf-URL gesendet.

Dadurch werden Apps effizienter, da sie genau ermitteln können, wann eine Änderung vorgenommen wird, und nicht auf fortlaufende oder sogar periodische Graph API-Anfragen angewiesen sind, um die neuesten Inhalte abzurufen.

Der Support von Webhooks für Workplace wird vom selben Framework bereitgestellt wie Webhooks für Facebook.

Webhook-Themen abonnieren

Der Dialog Benutzerdefinierte Integration bearbeiten verfügt über Tabs zu jedem für Apps auf Workplace verfügbaren Webhook-Thema.

Der Tab „Webhooks“ im Dialog „Benutzerdefinierte Integration bearbeiten“

Stelle eine Rückruf-URL und ein Verifizierungs-Token bereit, um ein neues Webhook-Abonnement zu einem vorhandenen Thema hinzuzufügen. Wähle dann die Abonnementfelder aus, die für die von deiner App bereitgestellte Funktion erforderlich sind.

Du kannst pro Webhook-Thema nur eine URL abonnieren, aber du kannst dieselbe URL für mehrere Themen verwenden.

Verifizierungsanfragen verarbeiten

Wenn du ein neues Abonnement hinzufügst oder ein vorhandenes bearbeitest, führen Facebook-Server eine GET-Anfrage an deine Rückruf-URL aus, um die Gültigkeit des Rückrufservers zu überprüfen.

Ein Abfrage-String mit folgenden Parametern wird an diese URL angehängt:

hub.mode – Der String „subscribe“ wird in diesem Parameter übergeben.
hub.challenge – Ein zufälliger String.
hub.verify_token – Der verify_token-Wert, den du beim Erstellen des Abonnements angegeben hast.

Wenn du eine HTTP GET-Anfrage für deine Rückruf-URL erhältst, kannst du den verify_token-Parameter verwenden, um zu prüfen, ob die Anfrage von einem Facebook-Server kommt.

Webhook-Sicherheit

Alle Webhook-Anrufe an von Entwickler*innen definierte Rückruf-URLs erfolgen über HTTPS, wodurch die Sicherheit von Webhook-Payloads auf Transportebene gewährleistet wird.

Um zusätzliche Sicherheit zu bieten, wird ein HTTP-Header X-Hub-Signature-256 zu jeder POST-Payload hinzugefügt, den du verwenden solltest, um sicherzustellen, dass die Payload von einem Facebook-Server stammt.

Umfassende Informationen zu diesem Verhalten findest du in der Dokumentation zum Facebook Webhook Framework.

Webhook-Themen

Aktivitäten in Workplace werden in Themen gruppiert. Jedes Thema verfügt über eine Reihe von Feldern, die eine Verknüpfung zu Events zu einem bestimmten Thema herstellen. Apps können Webhook-Updates zu jedem Thema und für bestimmte Felder innerhalb eines Themas abonnieren.

Workplace stellt derzeit Webhooks für folgende Themen und Gruppen bereit:

Seite

Weitere Informationen findest du in den Referenzdokumenten zu Seitenthemen.

Abonnementfeld	Verhalten
`mention`	Wird ausgelöst, wenn eine Seite mit benutzerdefinierter Integration (Bot) in einer Gruppe erwähnt wird.
`messages`	Wird ausgelöst, wenn eine Seite mit benutzerdefinierter Integration (Bot) eine Nachricht in Work Chat erhält.
`message_deliveries`	Wird ausgelöst, wenn eine von einer Seite mit benutzerdefinierter Integration (Bot) gesendete Nachricht zugestellt wird.
`messaging_postbacks`	Wird ausgelöst, wenn ein Postback-Button in Work Chat gedrückt wird.
`message_reads`	Wird ausgelöst, wenn eine Nachricht von einer Seite mit benutzerdefinierter Integration (Bot) von der empfangenden Person gelesen wird.

Gruppe

Weitere Informationen findest du in den Referenzdokumenten zu Gruppenthemen.

Abonnementfeld	Verhalten
`posts`	Wird ausgelöst, wenn ein Beitrag in einer Gruppe hinzugefügt, aktualisiert oder gelöscht wird.
`comments`	Wird jedes Mal ausgelöst, wenn ein neuer Kommentar zu einem Beitrag in einer Gruppe hinzugefügt, aktualisiert oder gelöscht wird.
`membership`	Wird ausgelöst, wenn sich die Mitgliedschaft einer Gruppe ändert.

Nutzer*innen

Weitere Informationen findest du in den Referenzdokumenten zu Nutzer*innen-Themen.

Abonnementfeld	Verhalten
`status`	Wird ausgelöst, wenn eine Nutzerin ein Status-Update in seinem*ihrem eigenen Profil postet oder bearbeitet.
`events`	Wird jedes Mal ausgelöst, wenn eine Nutzerin ein Event erstellt, annimmt oder ablehnt.
`message_sends`	Wird jedes Mal ausgelöst, wenn eine Nutzerin eine Workplace-Chatnachricht sendet.

Link

Weitere Informationen findest du in den Dokumenten zu authentifizierten Vorschauen.

Abonnementfeld	Verhalten
`preview`	Wird ausgelöst, wenn Workplace Informationen über eine URL abrufen muss.
`collection`	Nur für Apps relevant, die auf der Positivliste sind und die hierarchische Navigation des Beitrags-Editors unterstützen.

Sicherheit

Weitere Informationen findest du in den Referenzdokumenten zu Sicherheitsthemen.

`sessions`

Events, die ausgelöst werden, wenn sich ein*e Nutzer*in in Workplace ein- oder ausloggt.

Event Verhalten

Event	Verhalten
`log_in`	Eine Nutzerin hat sich über einen Internetbrowser oder eine mobile App mit seinem*ihrem Passwort oder SSO in Workplace eingeloggt.
`log_out`	Eine Nutzerin hat sich über einen Internetbrowser oder eine mobile App mit seinemihrem Passwort oder SSO in Workplace ausgeloggt. Dies umfasst nicht die von einemeiner Administrator*in initiierte, erzwungene Abmeldung (siehe `admin_force_log_out`).

log_in

Ein*e Nutzer*in hat sich über einen Internetbrowser oder eine mobile App mit seinem*ihrem Passwort oder SSO in Workplace eingeloggt.

log_out

Ein*e Nutzer*in hat sich über einen Internetbrowser oder eine mobile App mit seinem*ihrem Passwort oder SSO in Workplace ausgeloggt.

Dies umfasst nicht die von einem*einer Administrator*in initiierte, erzwungene Abmeldung (siehe admin_force_log_out).

`passwords`

Events, die ausgelöst werden, wenn ein*e Nutzer*in sein*ihr Passwort ändert oder das Zurücksetzen des Passworts anfordert.

Event	Verhalten
`password_change`	Ein Passwort wurde über die Passwortwiederherstellung oder die Kontoeinstellungen geändert.
`password_reset_request`	Der Prozess zur Wiederherstellung eines Passworts wurde initiiert und ein Code an die E-Mail-Adresse desder Nutzerin gesendet.
`password_reset_wrong_code`	Eine Nutzerin hat einen falschen Code für das Zurücksetzen des Passworts eingegeben.
`password_reset_success`	Der Prozess für das Zurücksetzen eines Passworts wurde erfolgreich abgeschlossen.

`admin_activity`

Events, die ausgelöst werden, wenn ein*e Administrator*in zu einer Workplace-Community hinzugefügt oder daraus entfernt wird.

Event	Verhalten
`admin_set_to_unclaimed`	Eine Administratorin hat den Status eines Kontos im Administrationsbereich oder über die Account Management API auf nicht beansprucht festgelegt.
`admin_force_log_out`	Eine Administratorin hat im Administrationsbereich die Abmeldung eineseiner Nutzerin auf allen Geräten erzwungen.
`admin_deactivate`	Eine Administratorin hat ein Konto im Administrationsbereich oder über die Account Management API deaktiviert.
`admin_activate_account`	Eine Administratorin hat ein Konto im Administrationsbereich oder über die Account Management API aktiviert.
`force_password_reset`	Eine Administratorin hat im Administrationsbereich das Zurücksetzen eines Passworts erzwungen.
`admin_create_account`	Eine Administratorin hat im Administrationsbereich ein Konto erstellt.

`two_factor`

Events, die ausgelöst werden, wenn ein*e Nutzer*in die zweistufige Authentifizierung aktiviert oder deaktiviert.

Event	Verhalten
`two_factor_enable`	Eine Nutzerin hat die zweistufige Authentifizierung auf dem Einstellungen-Tab aktiviert. Dies erfasst nicht die Bestätigung eines bestimmten Telefons, sondern zeigt an, dass die Funktion aktiviert wurde.
`two_factor_disable`	Eine Nutzerin hat die zweistufige Authentifizierung auf dem Einstellungen-Tab deaktiviert. Dies erfasst nicht die Deaktivierung der zweistufigen Authentifizierung auf einem bestimmten Telefon, sondern zeigt an, dass die Funktion deaktiviert wurde.