Création de webhooks dans le Centre d’administration

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

Un webhook envoie une demande HTTP à une URL spécifiée en réponse à un événement, comme un déclencheur ou un automatisme qui s’exécute dans Zendesk Support. Les développeurs Web utilisent généralement un webhook pour invoquer un comportement dans un autre système.

Remarque – Les comptes d’essai sont limités à un maximum de 10 webhooks.

Cet article aborde les sujets suivants :

À propos des webhooks
Création d’un webhook
Test d’un webhook

À propos des webhooks

Les webhooks sont utilisés pour s’intégrer avec vos services tiers ou votre système interne. Par exemple, vous pouvez utiliser les webhooks pour :

Prévenir votre équipe dans Slack quand un ticket urgent est créé
Transmettre les détails de ticket à votre équipe de documentation dans Asana une fois un ticket résolu
Notifier votre système interne quand un événement de ticket important survient

Vous pouvez utiliser des webhooks pour transmettre des informations à des services tiers et des API REST qui acceptent le contenu JSON, XML ou codé pour les formulaires dans les demandes HTTP. Vous pouvez aussi utiliser des webhooks pour transmettre des paramètres d’URL à une URL.

Les webhooks sont utilisés par les automatismes et les déclencheurs dans Zendesk Support quand un ticket remplit des conditions spécifiques. Les webhooks sont importants car ils sont les moyens par lesquels les déclencheurs et automatismes provoquent des actions basées sur les réponses HTTP des services tiers.

Vous pouvez utiliser n’importe quelle balise de contenu disponible pour insérer des données de ticket dans les demandes HTTP.

Quand une règle de gestion exécute un webhook, elle met en file d’attente le travail à exécuter, mais ne l’exécute pas immédiatement. Comme les tâches liées aux webhooks s’exécutent indépendamment, il n’y a aucune garantie que les webhooks s’exécutent dans un ordre particulier.

Les demandes de webhook sont automatiquement réessayées jusqu’à 3 fois si le point de terminaison renvoie certains codes de réponse HTTP. À la différence des cibles, l’échec de demandes consécutives ne désactive pas les webhooks. Pour en savoir plus et des exemples de scénarios de ré-essais, consultez Surveillance des webhooks dans la documentation destinée aux développeurs.

Création d’un webhook

La création d’un webhook se fait en 2 parties. D’abord, vous définissez les détails du webhook. Puis vous le joignez à un déclencheur ou un automatisme pour pouvoir l’utiliser.

Remarque – Lors de la configuration d’un webhook à intégrer avec un tiers, vous devrez peut-être consulter sa documentation.

Pour créer un webhook

Dans le Centre d’administration, cliquez sur l’icône Applications et intégrations dans la barre latérale, puis sélectionnez Webhooks > Webhooks.
Cliquez sur Actions et sélectionnez Créer un webhook.
Configurez le webhook à intégrer au service ou système tiers.
Pour en savoir plus, consultez Points de terminaison des webhooks et Authentification de votre webhook.
(Facultatif) Cliquez sur Tester le webhook pour vérifier qu’il fonctionne correctement.
Cliquez sur Suiv. pour connecter le webhook à un déclencheur ou un automatisme Support. Cela s’effectue dans l’interface d’administration de Zendesk Support.
Retournez à la page Créer un webhook dans le Centre d’administration et cliquez sur Terminer la configuration.

Une fois votre webhook créé et connecté à un déclencheur ou un automatisme, vous pouvez voir les détails du webhook, les abonnements aux événements et l’activité dans la page Webhooks du Centre d’administration. Pour en savoir plus, consultez Gestion des webhooks dans le Centre d’administration.

Points de terminaison des webhooks

Les webhooks envoient des demandes et reçoivent des réponses de l’URL de point de terminaison spécifié lors de leur création. C’est comme cela qu’ils s’intègrent avec les services, API et systèmes tiers.

L’URL de point de terminaison utilise le format suivant : https://www.yourdomain.com/path.

Bien que cela ne soit pas obligatoire, l’utilisation de HTTP sécurisé (HTTPS) est recommandée. En fournissant une URL de point de terminaison sécurisé, vous activez l’authentification et pouvez transférer des données en toute sécurité.

Authentification de votre webhook

Si votre webhook est intégré avec un point de terminaison sécurisé, vous avez 3 options pour authentifier le webhook et les données envoyées. Vous pouvez vouloir référencer une documentation tierce à propos des demandes d’authentification de votre point de terminaison ou travailler avec un développeur dans votre équipe pour déterminer la bonne méthode d’authentification pour votre webhook.

Aucune requise - Aucune authentification n’est configurée ou requise.
Authentification élémentaire - Utilisez un nom d’utilisateur et un mot de passe pour authentifier le webhook.
Token du porteur - Utilisez un token d’accès OAuth pour authentifier le webhook.

Si vos développeurs ont besoin de plus amples informations au sujet de l’authentification des webhooks, consultez Sécurité et authentification de webhook.

Connexion d’un webhook à un déclencheur ou un automatisme

Pour qu’un webhook soit utile, il doit être connecté à un déclencheur ou un automatisme. Les déclencheurs et les automatismes spécifient les circonstances dans lesquelles le webhook doit être invoqué.

Pour connecter un webhook à un déclencheur Support

Dans le Centre d’administration, cliquez sur l’icône Objets et règles dans la barre latérale, puis sélectionnez Règles de gestion > Déclencheurs.
Remarque – Si vous créez ou modifiez un webhook, cliquez sur Gérer les règles de gestion.
Créez un nouveau déclencheur ou automatisme ou modifiez-en un qui existe déjà en plaçant votre curseur sur l’icône d’options () et en cliquant sur Modifier.
Pour les déclencheurs, sous Actions, cliquez sur Ajouter une action. Sélectionnez Notifier le webhook et choisissez votre webhook. Cliquez sur Enregistrer.

Pour connecter un webhook à un automatisme Support

Dans le Centre d’administration, cliquez sur l’icône Objets et règles dans la barre latérale, puis sélectionnez Règles de gestion > Automatismes.
Remarque – Si vous créez ou modifiez un webhook, cliquez sur Gérer les règles de gestion.
Créez un nouveau déclencheur ou modifiez-en un qui existe déjà en plaçant votre curseur sur l’icône d’options () et en cliquant sur Modifier.
Pour les automatismes, sous Exécuter ces actions, cliquez sur l’icône ajouter une action (). Sélectionnez Notifications : Notifier le webhook et choisissez votre webhook. Cliquez sur Envoyer.

Test d’un webhook

Dans le Centre d’administration, vous avez l’option de tester le webhook avec plusieurs sources d’événements et demandes. En plus de l’accès aux webhooks spécifiquement pour les tester, vous pouvez aussi tester un webhook pendant sa création ou sa modification.

Pour tester un webhook

Dans le Centre d’administration, cliquez sur l’icône Applications et intégrations dans la barre latérale, puis sélectionnez Webhooks > Webhooks.
Trouvez le webhook dans la liste, puis cliquez sur l’icône du menu des options () sur la ligne du webhook et cliquez sur Tester le webhook.
Dans le volet Tester le webhook, sélectionnez Tester la source de l’événement. Ceci est un déclencheur joint ou un exemple de ticket que vous pouvez utiliser pour tester votre URL de point de terminaison.
Saisissez les détails de votre demande de test (corps, paramètres ou en-tête de la demande).
Cliquez sur Envoyer le test. La réponse est visible dans le volet en dessous de la demande de test.