Nutze Webhooks, um über Ereignisse in deinem Forum informiert zu werden.
Wenn das Ereignis eintritt — zum Beispiel, wenn ein neuer Benutzer ein Konto in Ihrem Forum erstellt — erstellt Website Toolbox ein Event-Objekt. Dieses Objekt enthält alle relevanten Informationen darüber, was gerade passiert ist, einschließlich der Art des Ereignisses und der mit diesem Ereignis verknüpften Daten. Anschließend senden wir das Event-Objekt als JSON über eine HTTP-POST-Anfrage an Ihre Webhook-URL.
Webhooks funktionieren hervorragend, wenn sie mit der Foren-API kombiniert werden. Zum Beispiel kann der Webhook Ihre Anwendung benachrichtigen, wenn sich ein neuer Benutzer für Ihr Forum anmeldet, und dann können Sie die API verwenden, um Änderungen am Forenkonto dieses Benutzers vorzunehmen.
Der Growth- oder Pro-Plan für das Forum ist erforderlich, um diese Funktion nutzen zu können.
Konfiguration Ihrer Webhook-Einstellungen
- Loggen Sie sich in Ihr Website Toolbox-Konto ein.
- Klicken Sie auf den Link Integrieren.
- Klicken Sie auf den Webhook-Link.
- Klicken Sie auf die Schaltfläche Webhook hinzufügen.
- Geben Sie Ihre Webhook-URL ein und wählen Sie die Ereignisse aus, die Sie erhalten möchten.
- Klicken Sie auf Speichern.
Sie können mehrere Webhooks erstellen, um Ereignisse an verschiedene URLs zu senden. Jeder Webhook kann so konfiguriert werden, dass er verschiedene Arten von Ereignissen empfängt.
Auf einen Webhook antworten
Sehen Sie sich unseren Beispielcode für den Empfang eines Webhook-Events an.
Um den Empfang eines Webhooks zu bestätigen, sollte Ihr Endpunkt einen 2xx-HTTP-Statuscode zurückgeben. Alle anderen Informationen, die in den Anforderungsheadern oder im Anforderungstext zurückgegeben werden, werden ignoriert. Alle Antwortcodes außerhalb dieses Bereichs, einschließlich 3xx-Codes, weisen darauf hin, dass Sie den Webhook nicht erhalten haben. Dies bedeutet, dass eine URL-Umleitung oder eine Antwort „Nicht geändert“ als Fehler behandelt wird.
Wenn ein Webhook aus irgendeinem Grund nicht erfolgreich empfangen wird, werden wir weiterhin versuchen, den Webhook bis zu 3 Tage lang einmal pro Stunde zu senden.
Ein Beispielereignis
{
„api_version“: „1",
„data“: {
„object“: {
„signature“: „Danke, John.“ ,
„name“: „John Doe“,
„allowEmails“: false,
„lastPostTimestamp“: 0,
„userGroups“: [7440, 2452, 52423],
„userTitle“: „Poweruser“,
„reputation“: 423,
„username“: „john“,
„postCount“: 32,
„userId“: 181855,
„lastVisitTimestamp“: 1322811119,
„instantMessagingType“: „“,
„instantMessagingId“: „“, „object“:
„Benutzer“, „unsichtbar“: falsch,
„email“: "johnDoe@gmail.com
„, „avatarUrl“: "https://test.com/images/avatar.png
„,
„joinDateTimestamp“: 1322811119,
„enableMessages“: true
}},
„Objekt“: „Ereignis“,
„ID“: 1534,
„type“: „user.created“,
„mode“: „live“
}
Webhook-Ereignisse und Antworten anzeigen
Sie können die Ereignisse, die an Ihren Webhook gesendet wurden, und die Antwort, die von Ihrem Webhook empfangen wurde, einsehen, indem Sie die folgenden Anweisungen befolgen:
- Loggen Sie sich in Ihr Website Toolbox-Konto ein.
- Klicken Sie auf den Link Integrieren.
- Klicken Sie auf den Webhook-Link.
- Klicken Sie auf die Anzahl der Ereignisse für den Webhook, den Sie anzeigen möchten.