Utilisez les webhooks pour être informé des événements qui se produisent sur 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 au format JSON à l'URL de votre webhook via une requête HTTP POST.
Les webhooks fonctionnent parfaitement lorsqu'ils sont combinés à l'API du forum. Par exemple, le webhook peut avertir votre application lorsqu'un nouvel utilisateur s'inscrit sur votre forum, puis vous pouvez utiliser l'API pour apporter des modifications au compte de forum de cet utilisateur.
Le forfait Forum Growth ou Pro est requis pour utiliser cette fonctionnalité.
Configuration des paramètres de votre webhook
- Connectez-vous à votre compte Website Toolbox.
- Cliquez sur le lien Intégrer.
- Cliquez sur le lien Webhook.
- Cliquez sur le bouton Ajouter un Webhook.
- Entrez l'URL de votre webhook et sélectionnez les événements que vous souhaitez recevoir.
- Cliquez sur Enregistrer.
Vous pouvez créer plusieurs webhooks pour envoyer des événements à différentes URL. Chaque webhook peut être configuré pour recevoir différents types d'événements.
Répondre à un webhook
Consultez notre exemple de code pour recevoir un événement Webhook.
Pour accuser réception d'un webhook, votre terminal 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 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 correctement pour quelque raison que ce soit, nous continuerons à essayer de l'envoyer une fois par heure pendant 3 jours maximum.
Un exemple d'événement
{
« api_version » : « 1",
« data » : {
« object » : {
« signature » : « Merci, John. » ,
« name » : « John Doe »,
« AllowEmails » : false,
« LastPostTimestamp » : 0,
« UserGroups » : [7440, 2452, 52423], « UserTitle » : « Utilisateur expérimenté »,
« réputation » : 423, « nom d'utilisateur » : « john »,
« PostCount » : 32,
« UserId » : 181855,
« LastVisitTimestamp » : 1322811119,
« InstantMessagingType » :
« », « InstantMessagingId » : « »,
« object » : « Utilisateur », « 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 du webhook
Vous pouvez consulter 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 :
- Connectez-vous à votre compte Website Toolbox.
- Cliquez sur le lien Intégrer.
- Cliquez sur le lien Webhook.
- Cliquez sur le nombre d'événements du webhook que vous souhaitez consulter.