Gestion des webhooks

Accès rapide : Centre d’administration > Applications et intégrations > Webhooks > Webhooks

Les webhooks sont créés et gérés dans le Centre d’administration Zendesk à partir de la page Webhooks.

Vous devez être un administrateur ou un agent dans un rôle personnalisé avec la permission de gérer les webhooks.

Cet article aborde les sujets suivants :

• Modification et gestion des webhooks
• Affichage de l’activité d’un webhook
• Débogage d’un webhook

Modification et gestion des webhooks

Dans la plupart des cas, les administrateurs peuvent modifier, cloner, désactiver et supprimer les webhooks. Cependant, les webhooks qui sont créés par les exigences de l’application peuvent être modifiés, mais ne peuvent pas être clonés ou supprimés. Les webhooks créés par les exigences de l’application peuvent être mis à jour par le développeur de l’application et remplacer les modifications effectuées par les administrateurs du compte. Une fois un webhook créé, vous ne pouvez pas changer sa méthode de connexion.

Pour modifier un webhook

1. Dans le Centre d’administration, cliquez sur l’icône Applications et intégrations dans la barre latérale, puis sélectionnez Webhooks > Webhooks.
2. Trouvez le webhook dans la liste, puis cliquez sur l’icône du menu des options () sur la ligne du webhook et cliquez sur Modifier.
3. Modifiez le webhook en fonction de vos besoins.

   Tous les champs sont modifiables. Cependant, quand vous utilisez l’authentification, vous ne pouvez pas afficher la clé, le token et le mot de passe après la création ou la mise à jour du webhook. Pour supprimer un en-tête personnalisé, cliquez sur l’icône de suppression ().

4. (Facultatif) Testez les modifications du webhook.
5. Cliquez sur Enregistrer.

Pour cloner un webhook

1. Dans le Centre d’administration, cliquez sur l’icône Applications et intégrations dans la barre latérale, puis sélectionnez Webhooks > Webhooks.
2. Trouvez le webhook dans la liste, puis cliquez sur l’icône du menu des options () sur la ligne du webhook et cliquez sur Cloner.
3. Modifiez le nom du webhook et le webhook en fonction de vos besoins.
4. Cliquez sur Mettre à jour.

Pour désactiver un webhook

1. Dans le Centre d’administration, cliquez sur l’icône Applications et intégrations dans la barre latérale, puis sélectionnez Webhooks > Webhooks.
2. Trouvez le webhook dans la liste, puis cliquez sur l’icône du menu des options () sur la ligne du webhook et cliquez sur Désactiver.
3. Dans la boîte de dialogue de confirmation, cliquez sur Désactiver.

Pour supprimer un webhook

1. Dans le Centre d’administration, cliquez sur l’icône Applications et intégrations dans la barre latérale, puis sélectionnez Webhooks > Webhooks.
2. Cherchez le webhook dans la liste, cliquez sur l’icône du menu des options () dans la ligne du webhook, puis cliquez sur Supprimer.
3. Cliquez sur Supprimer.

Affichage de l’activité d’un webhook

Chaque webhook a un journal d’activité. En plus d’un enregistrement détaillé des invocations, vous pouvez aussi voir le nombre de demandes pour les 7 derniers jours.

Une invocation de webhook est automatiquement réessayée jusqu’à 3 fois si le point de terminaison renvoie certains codes de réponse HTTP. Pour en savoir plus et des exemples de scénarios de ré-essais, consultez Logique de ré-essai des webhooks dans la documentation destinée aux développeurs.

Zendesk s’efforce de ne distribuer les actions aux webhooks qu’une seule fois, mais nous ne pouvons pas le garantir. Il est possible qu’un webhook soit invoqué plusieurs fois par la même action. Pour détecter les invocations en double, vous pouvez utiliser les signatures de webhook. Si c’est un problème pour votre workflow, assurez-vous que les actions qui résultent de vos webhooks sont idempotentes.

1. Dans le Centre d’administration, cliquez sur l’icône Applications et intégrations dans la barre latérale, puis sélectionnez Webhooks > Webhooks.
2. Trouvez le webhook dans la liste, puis cliquez sur l’icône du menu des options () sur la ligne du webhook et cliquez sur Afficher les détails.
3. Cliquez sur l’onglet Activité.
4. Cliquez sur Filtrer pour filtrer le journal d’activité par date de début, heure de début, date de fin, heure de fin ou statut, puis cliquez sur Appliquer les filtres.

Débogage d’un webhook

Si un webhook ne fonctionne pas correctement, les invocations qui échouent seront visibles dans le journal d’activité du webhook. Vous pouvez filtrer le journal d’activité par statut Échec ou par un type d’erreur spécifique. Dans l’onglet Activité, vous pouvez aussi cliquer sur un ID d’invocation pour afficher la demande et la réponse pour une invocation spécifique du webhook.

Dans la plupart des cas, la réponse provient du service tiers qui reçoit la demande du webhook, et non de Zendesk. En général, vous devez collaborer avec ce service pour résoudre les erreurs.

Vous pouvez utiliser le code numérique dans le statut de réponse pour diagnostiquer les problèmes. Ces codes de statut de réponse sont standards pour toutes les demandes HTTP. Pour une liste des codes de statut de réponse HTTP standards et leur signification, consultez HTTP response status codes dans la documentation Web de MDN.

Remarque – Si un service utilise des codes de statut de réponse HTTP personnalisés, vous devrez peut-être consulter sa documentation.

Un délai d’expiration de 10 secondes s’applique aux demandes de webhooks. Un statut de réponse « Failed: 504 Gateway Timeout » indique qu’un service n’a pas répondu à la demande d’un webhook dans les délais. Ce délai d’expiration n’est pas modifiable.