Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.qwoty.io/llms.txt

Use this file to discover all available pages before exploring further.

Les webhooks sont des messages automatisés envoyés par Qwoty lorsqu’un événement se produit dans notre système. Chaque action notifiée possède un payload spécifique et est envoyée sous forme de requête HTTP POST vers un endpoint HTTPS de votre serveur. Les webhooks vous aident à intégrer votre application avec Qwoty et à réagir aux événements en temps réel.

​
Ajouter un endpoint webhook

Pour commencer à écouter les messages webhook envoyés par Qwoty, accédez aux paramètres webhook dans le tableau de bord, cliquez sur Ajouter un webhook, fournissez une URL HTTPS publique que vous contrôlez, puis sélectionnez les types d’événements que vous souhaitez recevoir. Vous pouvez ajouter plusieurs endpoints si vous souhaitez séparer les événements par destination.

​
Types d’événements

Qwoty prend en charge une variété de types d’événements webhook pour des entités telles que les clients, les devis et plus encore. Lorsqu’un événement se produit, Qwoty envoie un POST webhook à votre endpoint avec un payload JSON contenant : 
{
  "event": "quote.update",
  "workspace_id": "13324049",
  "associated_object_id": "44",
  "associated_object_type": "quote"
}

​
Consommer les webhooks

Les livraisons de webhooks sont toujours des requêtes HTTPS POST contenant un corps JSON. Votre endpoint doit :
  1. Retourner rapidement un statut 2xx avant d’effectuer une logique complexe pour éviter les timeouts.
  2. Vérifier les signatures et horodatages des webhooks pour garantir l’authenticité et se protéger contre les attaques par rejeu.

​
Bonnes pratiques

  • Traitement idempotent : protégez-vous contre les événements dupliqués en vous assurant que votre logique de traitement peut gérer en toute sécurité le même événement plus d’une fois.
  • Récupérez le dernier état de l’entité : comme les événements peuvent être retentés avec des données obsolètes, envisagez de récupérer le dernier état de l’objet concerné après réception d’un webhook.
  • Liste blanche d’IP statiques : si votre endpoint webhook est derrière un pare-feu, autorisez le trafic provenant des IP des serveurs webhook de Qwoty.

​
Gérer les webhooks

Qwoty prend en charge les opérations API pour :
  • Créer des endpoints webhook
  • Lister les endpoints webhook
  • Récupérer un endpoint webhook spécifique
  • Mettre à jour les endpoints webhook
  • Supprimer les endpoints webhook

​
Livraison des événements et planning de réessai

Lorsque Qwoty tente de livrer des événements webhook :
  • Si votre endpoint répond avec un statut non-2xx, Qwoty réessaiera la livraison selon un planning (par exemple, secondes, minutes, heures d’intervalle).
  • La livraison des événements n’est pas garantie dans un ordre strict, concevez donc votre logique de traitement en conséquence.