Les webhooks sont des rappels HTTP définis par l'utilisateur. Ils sont déclenchés par un événement quelconque dans Oktave et peuvent faciliter l'intégration de différentes applications ou d'API tierces.

Chaque type d'événement (tel qu'une nouvelle réponse enregistrée ou un ajout de dans la liste noire) envoie un webhook avec un format correspondant à ce type.

Pour les nouvelles réponses, Oktave envoie une requête HTTP à votre serveur avec le contenu de la réponse pour chaque question, la campagne concernée, le questionnaire, etc. Cette requête HTTP est un POST. Ces demandes HTTP sont cryptées avec TLS et envoyées via une connexion HTTPS.

Votre application web répondra toujours de la même façon à un webhook Oktave. La réponse attendue est un simple HTTP 200 OK. Il s'agit principalement d'événements pour lesquels Oktave informe votre application web qu'un événement s'est produit, mais n'attend pas d'interaction.

En cas de réponse autre qu'un HTTP 200 OK, une nouvelle tentative d'appel sera réalisée quelques minutes plus tard et ce jusqu'à 3 fois avec un délais toujours plus long.

Oktave enverra plusieurs en-têtes HTTP avec tous les webhooks afin que vous puissiez valider la requête : Oktave-Event-Id, Oktave-Signature, Oktave-Timestamp. Le signature utilise token webhook secret de votre compte pour créer une signature numérique à partir de l'identifiant de l'évènement et de sa date. Pour vérifier qu'une requête entrante provient de Oktave, utilisez le SDK Oktave pour valider la signature.

Vous trouverez plus d'informations sur la sécurité et des examples pour la validation des webhooks entrants sur la page Sécurité des webhooks.

Il existe plusieurs options différentes. La première consiste à imiter la requête Oktave entrante à l'aide d'un outil comme Paw ou Postman qui vous permet d'envoyer facilement des requêtes HTTP à votre point de terminaison. Cette option est très utile pour le débogage local sur votre propre ordinateur.

Oktave vous enverra un rapport par email si un webhook ne fonctionne pas correctement.

Oktave utilise un pool d'adresses IP pour envoyer des demandes de webhook. Il n'existe donc pas de plage spécifique d'adresses IP que vous devriez autoriser pour les webhooks Oktave. Nous vous suggérons plutôt de placer certains serveurs dans une zone démilitarisée (DMZ) et d'envoyer la demande de webhook Oktave par l'intermédiaire de ces serveurs vers vos serveurs d'application.

Vous pouvez utiliser ngrok ou un autre outil pour mettre en place un tunnel entre un serveur web fonctionnant sur votre ordinateur local et une URL web accessible au public que vous pouvez fournir à Oktave pour qu'il l'utilise pour les webhooks.