Aller au contenu principal

Comment configurer les webhooks et leurs événements?

Catherine Peart
Mise à jour
IntroUn webhook est un moyen pour Urbantz de fournir des informations aux applications de nos clients. Les webhooks sont déclenchés par des événements spécifiques.

Aperçu

  1. Mise en place et configuration
  2. Dépannage

1. Mise en place et configuration

Pour chaque événement déclenché sur la plateforme, le webhook est envoyé à l'adresse HTTPS ou SFTP que vous avez fournie.

Si votre adresse HTTPS nécessite une authentification, il est possible de configurer des en-têtes.

Vous trouverez des détails sur les payloads dans cet article.

Les webhooks peuvent être configurés au niveau de la plateforme:

Webhook_General_FR.png

ou au niveau du flux:

Webhook_Flow_FR.png

  • Les webhooks associés aux tournées, aux tickets et à certains événements de tâches sont configurés au niveau de la plateforme.

Administration > Plateforme > Général > Intégrations 

    • round.created

    • round.validated

    • round.published

    • round.in_preparation

    • round.ongoing

    • round.completed

    • ticketCreated

    • ticketUpdated

    • ticketClosed

    • taskStatusChanged
    • taskChanged
    • taskRejected

 

  • Vous pouvez sélectionner l'URL, le protocole et les événements souscrit.  (Tournées, Tickets et Tâches).

    Les webhooks associés aux tâches, aux optimisations, ou aux annonces sont configurés au niveau du flux.

Administration > Flux > Mode avancé > Webhooks

    • taskStatusChanged
    • taskChanged
    • optimisationComplete
    • announcementComplete
    • announcementCancelled
    • tasksAnnounced

Webhook screenshot FR.png

  • Vous pouvez également sélectionner un en-tête, une description et activer la notification en cas de non-livraison sur cette page.

    Si vous activez l'envoi d'un e-mail en cas de non-livraison, vous pouvez le configurer comme suit. 

 

2. Dépannage

Pour déterminer pourquoi un webhook spécifique échoue et où il échoue, vous pouvez suivre les étapes ci-dessous:

    • Vérifiez si le déclencheur a été activé

    • Vérifiez si le webhook a été correctement configuré (URL de l'adresse de destination)

    • Vérifiez s'il y a un filtre sur le webhook (expéditeur, optimisation)

    • Consultez le moniteur du système (voir l'article suivant pour plus de détails): 

      • Si rien ne peut être déterminé, veuillez contacter notre équipe de support en fournissant tous les résultats du dépannage.

Les problèmes peuvent être minimisés en configurant une notification par e-mail pour toutes les erreurs de webhook. Vous trouverez plus d'informations à ce sujet dans l'article suivant. 

 

 

Articles associés