Utilisation de Webhooks

Utilisez les 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 passer, 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 à l'URL de votre webhook via une requête HTTP POST.

Les webhooks fonctionnent très bien lorsqu'ils sont combinés à l'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 modifier le compte de forum de cet utilisateur.

Le forfait Growth ou Pro du forum est requis pour utiliser cette fonctionnalité.

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.updated, topic.supprimé, post.created, post.approved, post.updated, post.deleted, post.approved, post.updated, post.deleted, conversation.created et message.created. Veuillez nous faire savoir si vous avez besoin d'un nouvel événement Webhook.

Configuration des paramètres de votre webhook

1. Connectez-vous à votre compte Website Toolbox.
2. Cliquez sur le bouton Intégrez lien.
3. Cliquez sur le bouton Webhook lien.
4. Saisissez l'URL de votre webhook dans la zone de texte située à côté du Webhook option.

Répondre à 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 ou le corps de la demande est ignorée. Tous les codes de réponse situés 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 « Non modifiée » sera traitée comme un échec.

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

Un 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 reçue de votre webhook en suivant les instructions ci-dessous :

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

If you still need help, please contact us.