Webhooks allows you to be informed in real time every time a particular event chosen by you happens in Boondmanager. For exemple : To be alerted every time a project, or a resource is created...

Boondmanager allows you to create webhooks that will be triggered when a chosen event happens. When one of those events is detected, the Boondmanager webhook executes an http request and provides informations into the concerned card. This guide will teach you how to create and use those webhooks.

Stay on the track with our changelog

If you want to be informed when our team planifies/publishes new technical features , or if you use our APIs and want to be sure our new feature won't break your code, we advise you to subscribe to our changelog canal

 

Summary

Access to the Webhooks section

To access to webhooks, click on your first name (on the bottom right), then "Administration". You will find the webhooks menu in the technical section. 

 

Capture_d_e_cran_2021-05-05_a__15.15.00.png

Administration > webhooks

You will find in this section your webhooks's list :

Capture_d_e_cran_2021-04-02_a__10.59.09.png

Create your webhook

By clicking on the + button, you can add a webhook. You have ton enter :

  • A name : to identify the webhook
  • URL : called url when it triggers
  • Description : To describe more precisely your webhook's goal (it can be useful when you want to clean up and delete the useless webhooks)
  • Triggering events : A matrix table to choose your triggers

Webhook.png

Pour sélectionner les événements déclencheurs, vous pouvez cliquer sur une ligne ou sur une colonne pour tout sélectionner. Ou simplement cliquer sur les cases correspondantes à vos besoins.

 Attention

Si vous vous intégrez avec un outil comme Zapier ou Intergromat, attention à ne pas créer de boucle infinie en vous abonnant à un événement et en le re-déclenchant dans l'outil qui exploite le Webhook.

 

Tester votre Webhook et comprendre la réponse

Pour le tester, rendez-vous sur une fiche candidat et réalisez une modification (enregistrer pour déclencher le Webhook). Dans notre cas de test, nous allons modifier le candidat dont l’id est 36. Au moment de la modification, notre Webhook envoie une requête à l'url renseignée avec les informations suivantes :

ResponseWebhook.png

Voici l'explication détaillée des champs renvoyés par le Webhook :

data :
  id: Identifiant unique de l réponse
  type: Type de la réponse (sera toujours égal à "webhookevent")
  attributes:
    userToken: Utilisateur ayant déclenché le webhook
    clientToken: Client
    type: Type d'évènement mesuré
  relationships:
    webhook:
      id : Identifiant unique du webhook
      type: webhook
    dependsOn:
      id: Identifiant unique correspondant à l'entité modifiée/créée/supprimée/...
      type: type de l'entité modifiée
     log :
       id : Identifiant du log générée à la création/modification/suppression/...
       type: log

 

L’id du log , ainsi que l’id du dependsOn pourront être exploité à l’aide des api boondmanager( api/log/{id} OU api/{type}/{id}) afin de récupérer le détail de l’évènement ou de l’entité (utile pour savoir exactement ce qui a été créé/modifié/supprimé).

 

 

Nous espérons que cet article vous a été utile et nous vous invitons grandement à nous l'indiquer en votant juste en dessous.

S'il vous reste des questions sans réponse alors n'hésitez surtout pas à contacter notre service Support qui reste à votre écoute :

Contacter le support

Tel : (+33) 03 62 27 61 05

Boondmanager-Mascot-Desk-lg.png

Was this article helpful?
1 out of 1 found this helpful

Comments

0 comments

Please sign in to leave a comment.