Help > Forum > Website-Integration > Webhooks verwenden

Webhooks verwenden

Verwenden Sie Webhooks, um über Ereignisse in Ihrem Forum informiert zu werden.

Wenn das Ereignis eintritt - zum Beispiel wenn ein neuer Benutzer ein Konto in Ihrem Forum erstellt - Website Toolbox erstellt ein Event-Objekt. Dieses Objekt enthält alle relevanten Informationen darüber, was gerade passiert ist, einschließlich der Art des Ereignisses und der Daten, die mit diesem Ereignis verknüpft sind. Wir senden dann das Event-Objekt als JSON über eine HTTP POST-Anfrage an Ihre Webhook-URL.

Webhooks funktionieren hervorragend, wenn sie mit dem Foren-API. Beispielsweise 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.

Die folgenden Ereignisse werden derzeit unterstützt: user.created, user.approved, user.updated, user.deleted, user.email.verified, user.payment.received, user.paid_subscription.started, user.paid_subscription.ended, topic.created, topic.updated, topic.deleted, post.created, post.approved, post.updated, post.deleted, conversation.created und message.created. Bitte lassen Sie uns wissen , wenn Sie ein bestimmtes neues Webhook-Ereignis benötigen.


Konfigurieren der Webhook-Einstellungen

  1. Melden Sie sich bei Ihrem Website Toolbox-Konto an.
  2. Klicken Sie auf die Schaltfläche Einstellungen Link.
  3. In der Einstellungen auf die Schaltfläche Benachrichtigung Link.
  4. Geben Sie Ihre Webhook-URL in das Textfeld neben dem Webhook -Option.

Auf einen Webhook reagieren

Um den Empfang eines Webhooks zu bestätigen, sollte Ihr Endpunkt einen 2xx HTTP-Statuscode zurückgeben. Alle anderen Informationen, die in den Anforderungskopfzeilen oder dem Anforderungskörper zurückgegeben werden, werden ignoriert. Alle Antwortcodes außerhalb dieses Bereichs, einschließlich 3xx Codes, zeigen an, 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 einmal pro Stunde für bis zu 3 Tage zu senden.


Ein Beispielereignis

{
  "api_version": "1",
  "data": {
    "object": {
      "signature": "Thanks, John.",
      "name": "John Doe",
      "allowEmails": false,
      "lastPostTimestamp": 0,
      "userGroups": [7440, 2452, 52423],
      "userTitle": "Power User",
      "reputation": 423,
      "username": "john",
      "postCount": 32,
      "userId": 181855,
      "lastVisitTimestamp": 1322811119,
      "instantMessagingType": "",
      "instantMessagingId": "",
      "object": "User",
      "invisible": false,
      "email": "johnDoe@gmail.com",
      "avatarUrl": "https://test.com/images/avatar.png",
      "joinDateTimestamp": 1322811119,
      "enableMessages": true
    }
  },
  "object": "event",
  "id": 1534,
  "type": "user.created",
  "mode": "live"
}

Anzeigen von Webhook-Ereignissen und -Antworten

Sie können die Ereignisse, die an Ihren Webhook gesendet wurden, und die Antwort, die von Ihrem Webhook empfangen wurde, anzeigen, indem Sie die folgenden Anweisungen befolgen:

  1. Melden Sie sich bei Ihrem Website Toolbox-Konto an.
  2. Klicken Sie auf die Schaltfläche Inhalt Link.
  3. In der Inhalt auf die Schaltfläche Webhook Link. (Wenn es keine Webhook Link, das bedeutet, dass keine Webhook-URL in der Webhook-Einstellungen noch.)


If you still need help, please contact us.