Verwenden von Webhooks

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

Wenn das Ereignis eintritt - z. B. 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 verbundenen Daten. Wir senden das Event-Objekt dann als JSON über eine HTTP-POST-Anfrage an Ihre Webhook-URL.

Webhooks funktionieren gut, wenn sie mit der Forum-API kombiniert werden. Zum Beispiel kann der Webhook Ihre Anwendung benachrichtigen, wenn sich ein neuer Benutzer für Ihr Forum anmeldet, und Sie können dann die API verwenden, um Änderungen am Forumkonto dieses Benutzers vorzunehmen.

Das Forum Growth oder Pro-Plan ist erforderlich, um diese Funktion nutzen zu können.

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

Konfigurieren Ihrer Webhook-Einstellungen

1. Melden Sie sich bei Ihrem Website Toolbox-Konto an.
2. Klicken Sie auf das Integrieren verknüpfen.
3. Klicken Sie auf das Webhook verknüpfen.
4. Geben Sie Ihre Webhook-URL in das Textfeld neben der Webhook Option.

Auf einen Webhook reagieren

Um den Erhalt eines Webhooks zu bestätigen, sollte Ihr Endpunkt einen 2xx HTTP-Statuscode zurückgeben. Alle anderen Informationen, die in den Anforderungskopfzeilen oder im Anforderungstext zurückgegeben werden, werden 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 „Nicht geändert“ -Antwort 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": "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 den folgenden Anweisungen folgen:

1. Melden Sie sich bei Ihrem Website Toolbox-Konto an.
2. Klicken Sie auf das Inhalt verknüpfen.
3. Im Inhalt klicken Sie auf Webhook-Protokolle verknüpfen. (Wenn es keine gibt Webhook-Protokolle Link, das bedeutet, dass keine Webhook-URL im Webhook-Einstellungen noch.)

If you still need help, please contact us.