Créer un webhook sur Table (Baserow)

Table
1

:hourglass: Temps nécessaire : 1-5 min.
:thermometer: Niveau de difficulté : réservé aux profils techniques.
:key: pré-requis : Posséder une base de données contenant au moins une table.

Lien vers l’article officiel de Baserow (en anglais).

Pour créer un webhook sur Table, vous devez posséder au moins une base de données et une table.
:information_source: Pour savoir comment créer une base de données et une table, veuillez vous référer respectivement aux tutoriels suivants : Créer une base de données & Créer une table.

Cet article est dĂ©diĂ© aux webhooks sur Baserow. Il vous permettra de comprendre Ă  quoi cela peut servir, mais Ă©galement comment l’utiliser.

Qu’est-ce qu’un webhook (sur Baserow) ?

Un webhook (sur Baserow) est un outil permettant Ă  une table d’une base de donnĂ©es de communiquer avec une API selon le dĂ©clenchement de certains Ă©vĂšnements.
Les évÚnements déclencheur sont les suivants :

  • CrĂ©er une ligne de donnĂ©es
  • Modifier une ligne de donnĂ©es
  • Supprimer une ligne de donnĂ©es

Pour communiquer un webhook utilise des requĂȘtes HTTP.
Pour plus d’informations sur les requĂȘtes HTTP, consulter l’article suivant : ionos - RequĂȘtes HTTP.

Pour plus d’informations sur les webhooks de maniĂšre gĂ©nĂ©rale, consulter l’article suivant : RedHat - Webhook

Comment créer un webhook ?

Pour créer un nouveau webhook, commencez par vous rendre sur la table de votre de base de données sur laquelle vous souhaitez créer un webhook.

image

Cliquer sur les trois petits points à cÎté du bouton de choix de la vue.

image
image934×240 8.49 KB

Puis choisir « Webhhoks Â».

image

Une nouvelle fenĂȘtre apparait, dans celle-ci, choisir « Ajouter un webhook Â».

image

Paramétrer le webhook :

image
image689×1033 54.1 KB

  1. Nommer le webhook.
    Choisir un nom pertinent pour son webhook, il est conseillé de décrire en quelques mots son utilisation (à quoi va-t-il servir ?).

  2. Noms des champs
    Si cette option est cochée, le nom des champs sera utilisé dans le payload comme clés.
    Si cette option est décochée, les clés seront construites de la maniÚre suivante : field_{field_ID}.

  3. MĂ©thode
    DĂ©finir le verbe/ la mĂ©thode HTTP que vous souhaitez utiliser pour votre requĂȘte.
    :information_source: Pour plus d’informations, consulter : Mozilla.org - Methods

  4. URL
    DĂ©finir la destination de votre requĂȘte. Saisir un URL valide.
    Exemple : https://www.monDomaine.io/ma/route

  5. Types d’évĂšnements
    Vous pouvez choisir selon quel(s) Ă©vĂšnement(s) vous souhaitez qu’une requĂȘte soit envoyĂ©e.
    Vous pouvez alors composer avec les trois suivants :
    image
    Si vous souhaitez envoyer une requĂȘte pour tous les types Ă©vĂšnements, vous pouvez Ă©galement choisir l’option suivante :
    image

  6. EntĂȘtes additionnels
    DĂ©finir des entĂȘtes supplĂ©mentaires Ă  votre requĂȘte.

  7. Tester le webhook
    Vous pouvez tester le webhook pour vérifier que celui-ci est paramétré comme souhaité et que la destination reçoit bien les données.
    (Lors du test, des donnĂ©es fictives sont envoyĂ©es, mais lors d’une utilisation « classique Â» les donnĂ©es envoyĂ©es seront les donnĂ©es de la ligne affectĂ©e par l’évĂšnement).

  8. Enregistrer
    Ne pas oublier de sauvegarder son webhook. :slightly_smiling_face:

:warning: Si un webhook rencontre trop d’erreurs, il sera dĂ©sactivĂ© automatiquement.
Vous devrez alors vous rendre dans les paramÚtres du webhook pour le réactiver.