Que sont les Webhooks ?

Grâce à cet article, vous comprendrez ce que sont les Webhooks et leur rôle.

📘"Tapez tapez sur X à l'extérieur de Factorial quand Y se produit à l'intérieur de Factorial".

🚧Les Webhooks peuvent être utilisés directement ou via des plateformes ou services intermédiaires. Leur utilisation directe nécessite des connaissances techniques.

Les Webhooks vous permettent de concevoir ou de mettre en place des intégrations, comme la synchronisation entre les plateformes ou l'exécution d'une action après qu'un événement spécifique se soit produit. Lorsqu'un de ces événements est déclenché, une charge utile HTTP POST est envoyée à l'URL configurée du webhook. Les Webhooks peuvent être utilisés pour mettre à jour un LDAP externe, déclencher des processus, mettre à jour une autre application, ou même se connecter à une autre plateforme pour réaliser d'autres événements. Vous n'êtes limité que par votre imagination... et vos connaissances techniques.

Webhooks de Factorial

Des milliers de choses se produisent constamment à l'intérieur de Factorial sans que personne ne sache quand elles se produisent et c'est bien ainsi, les connaître toutes n'est pas utile et conduira probablement à la confusion. Mais il y en a quelques-uns qu'il est utile de connaître. Nous avons besoin de connaître le moment où ces événements se produisent et toute information associée. C'est pourquoi, il y a des points de terminaison disponibles où les URLs peuvent être associées à différents événements.

🚧URL

La même URL peut être utilisée pour obtenir des notifications pour tous les événements ou des notifications différentes par événement. Notez que si la même URL de réception des notifications est utilisée pour tous les événements, il peut être difficile de distinguer un événement d'un autre.

Lorsqu'un événement se produit chez Factorial, une requête POST est déclenchée vers l'URL de l'événement associé. Si la requête échoue pour une raison quelconque, une nouvelle tentative sera effectuée peu après.

S'abonner

L'inscription à un webhook est très simple, même si des connaissances techniques sont requises. Après avoir obtenu un jeton Oauth2 ou une crédence ApiKey, une simple requête curl avec l'identifiant de l'événement et l'URL suffit.

curl --request POST \ --url https://api.factorialhr.com/api/v1/webhooks \ --header 'Accept: application/json' \ --header 'Authorization: Bearer TOKEN' \ --header 'Content-Type: application/json' \ --data ' { "type": "employee_unterminated", "target_url": "https://foo.com/webhooks/employee_unterminated" } '

🚧Webhook existant

Si un webhook pour un événement existe déjà, la création d'un nouvel abonnement écrasera l'abonnement précédent.

Se désabonner

Pour supprimer un webhook ou arrêter l'abonnement à un événement, il suffit de faire une demande DELETE avec l'id de l'événement.

curl --request DELETE \ --url https://api.factorialhr.com/api/v1/webhooks \ --header 'Accept: application/json' \ --header 'Authorization: Bearer TOKEN' \ --header 'Content-Type: application/json' \ --data ' { "type": "employee_invited" } '

Lister

Pour afficher les webhooks actuellement configurés, effectuez le curl suivant. (plus d'informations sur la documentation de l'API)

curl --request GET \ --url https://api.factorialhr.com/api/v1/webhooks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer TOKEN'