Help > Forum > Intégration de sites Web > Utilisation de Webhooks

Utilisation de Webhooks

Utilisez webhooks pour être averti des événements qui se produisent dans votre forum.

Lorsque l'événement se produit - par exemple, lorsqu'un nouvel utilisateur crée un compte sur votre forum - Website Toolbox crée un objet Event. Cet objet contient toutes les informations pertinentes sur ce qui vient de se produire, y compris le type d'événement et les données associées à cet événement. Nous envoyons ensuite l'objet Event en tant que JSON à votre URL webhook via une requête HTTP POST.

Les webhooks fonctionnent très bien lorsqu'ils sont combinés avec le API du forum. Par exemple, le webhook peut avertir votre application lorsqu'un nouvel utilisateur s'inscrit à votre forum, puis vous pouvez utiliser l'API pour apporter des modifications au compte de forum de cet utilisateur.

Les événements suivants sont actuellement pris en charge : 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 et message.created. S'il te plaît faites-nous savoir si vous avez besoin d'un certain nouvel événement webhook.


Configuration des paramètres de votre webhook

  1. Connectez-vous à votre compte Toolbox Web.
  2. Cliquez sur le bouton Paramètres lien.
  3. Dans le Paramètres , cliquez sur le bouton Notification lien.
  4. Entrez l'URL de votre webhook dans la zone de texte située à côté de la fenêtre Webhook option.

Réponse à un webhook

Pour accuser réception d'un webhook, votre point de terminaison doit renvoyer un code d'état HTTP 2xx. Toute autre information renvoyée dans les en-têtes de la demande ou le corps de la demande est ignorée. Tous les codes de réponse en dehors de cette plage, y compris les codes 3xx, indiqueront que vous n'avez pas reçu le webhook. Cela signifie qu'une redirection d'URL ou une réponse « Not Modified » sera traitée comme un échec.

Si un webhook n'est pas reçu avec succès pour une raison quelconque, nous continuerons à essayer d'envoyer le webhook une fois par heure pendant 3 jours maximum.


Exemple d'événement

{
  "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"
}

Affichage des événements et des réponses webhook

Vous pouvez afficher les événements qui ont été envoyés à votre webhook et la réponse qui a été reçue de votre webhook en suivant les instructions ci-dessous :

  1. Connectez-vous à votre compte Toolbox Web.
  2. Cliquez sur le bouton Contenu lien.
  3. Dans le Contenu , cliquez sur le bouton Webhook lien. (S'il n'y a pas de Webhook , cela signifie qu'une URL webhook n'a pas été fournie dans le fichier paramètres webhook encore.)


If you still need help, please contact us.