Démarrer une conversation

Webhooks

Un webhook est une méthode utilisée par HRWize pour notifier aux applications tierces que quelque chose s'est produit dans le système HRWize, autre que lorsque cet événement est déclenché par des actions en masse telles que des téléchargements en masse.

Cette méthode est très utile dans le cas de téléchargements groupés. Ainsi, lorsque le webhook a été reçu, vous pouvez signaler l'API et faire quelque chose.

Dans HRWize, nous prenons actuellement en charge 18 webhooks qui couvrent trois actions principales dans le système - ajout, mise à jour et suppression.

Ces options sont présentement en Anglais.

employee.add
employee.update
employee.delete
timeoff.add
timeoff.update
timeoff.delete
expense.add
expense.update
expense.delete
mileage.add
mileage.update
mileage.delete
timesheet.add
timesheet.update
timesheet.delete
training.add
training.update
training.delete


Veuillez noter - Les webhooks ne se déclenchent que lorsqu'un élément d'information essentiel est concerné. Par exemple, lorsqu'un employé quitte l'entreprise, le système met à jour un certain nombre d'enregistrements tels que les congés et la formation, mais ces derniers ne déclencheront pas les webhooks. De même, si vous archivez un enregistrement, cela ne déclenchera pas de webhook.


Configuration des Webhooks

En tant qu'administrateur, il suffit d'aller sur :

Administration > Entreprise > Paramètres > API > Webhooks

Une fois sur place, cliquez sur le bouton "Ajouter", et vous devrez alors entrer 3 informations :

  • URL - Il s'agit de l'URL du script qui capturera le webhook entrant. Cette URL doit être disponible sur Internet pour que nous puissions l'envoyer par POSTE.
  • Secret - Il s'agit de votre phrase secrète ou de votre mot de passe que vous utiliserez pour valider un webhook entrant.
  • Événements - Il s'agit des événements que vous souhaitez que le webhook déclenche.

Mise en forme Webhooks

Dans HRWize, nos webhooks sont toujours envoyés par une demande POST et ont un format standard composé de :

  • Header - Il y a deux informations :
    • Content-Type - application/JSON ;
    • Autorisation - Ce sera votre secret.
  • Un corps - Le corps contiendra toujours les données JSON.

Pour la section de l'en-tête, nous vous recommandons vivement de vérifier le secret chaque fois que vous recevez un webhook et de vous assurer qu'il correspond au secret que vous attendez. Si vous ne le faites pas, il est possible que vous receviez des webhooks qui ne proviennent pas de HRWize.

Veillez également à vérifier l'URL et l'adresse IP de tout webhook entrant afin de vous assurer qu'il s'agit bien de celui que vous attendez.

Pour ce qui est du corps, il y aura un tableau JSON qui contient deux informations :

  • Événement - Il s'agit de l'événement qui a déclenché le webhook ;
  • ID - C'est l'ID de l'objet dans HRWize qui a provoqué le déclenchement.

Par exemple, si l'ID de l'employé 12345 était mis à jour, le corps ressemblerait un peu à ceci :

Si l'ID de congé 23456 a été supprimé, le corps de l'objet ressemblerait à ceci :

Choisir les fichiers ou glisser-déposer les fichiers
Utile ?
Oui
Non
  1. HRWize

  2. Posté
  3. Mis à jour

Commentaires