Les développeurs Web utilisent généralement un webhook pour invoquer un comportement dans un autre système. Par exemple, vous pouvez utiliser les webhooks pour :
Vous devez être un administrateur ou un agent dans unrôle personnaliséavec la permission de créer des webhooks. Les comptes d’essai sont limités à un maximum de 10 webhooks et une limite de débit de 60 invocations par minute.
À propos des webhooks
Il y a deux façons de connecter un webhook à une activité dans Zendesk Support :
- Abonnez le webhook à un ou plusieurs événements Zendesk. Utilisez cette méthode de connexion pour envoyer des demandes basées sur l’activité d’une organisation, d’un utilisateur, d’un centre d’aide ou d’une communauté. Pour une liste des types d’événement pris en charge, consultezWebhook - Types d’événementdans la documentation de référence de l’API.
- Connectez le webhook à undéclencheurou unautomatisme. Utilisez cette méthode de connexion pour envoyer des demandes basées sur l’activité d’un ticket.
Un webhook qui est abonné à un événement Zendesk ne peut pas se connecter à un déclencheur ou un automatisme. De même, un webhook qui est connecté à un déclencheur ou un automatisme ne peut pas être abonné aux événements Zendesk. Vous ne pouvez pas changer la méthode de connexion d’un webhook existant.
Abonnement aux événements Zendesk
Un webhook qui est abonné à un ou plusieurs événements Zendesk envoie toujours les demandes en utilisant la méthode HTTP POST. La demande inclut une charge JSON qui contient les données de l’événement. Vous ne pouvez pas changer la méthode HTTP ni la charge pour la demande. Pour en savoir plus sur les schémas de charge des événements, consultezWebhooks - Types d’événementsdans la documentation de référence de l’API.
Connexion aux déclencheurs ou automatismes
JSON
XML
Contenu codé du formulaire
Vous définissez le contenu de la demande quand vous connectez le webhook à un déclencheur ou un automatisme. Pour les webhooks qui utilisent la méthode HTTP POST, PUT ou PATCH avec un format de demande JSON ou XML, le contenu est la charge de la demande. Les webhooks qui utilisent d’autres méthodes HTTP ou d’autres formats n’incluent pas de charge de la demande. Par contre, vous pouvez ajouter des paramètres d’URL personnalisés sous la forme d’un tableau de deux chaînes clé-valeur.
Quand vous définissez la charge de la demande ou les paramètres de l’URL, vous pouvez utiliser toutes lesbalises de contenu disponiblespour insérer des données de ticket dans la demande.
Ordre des webhooks et nouvelles tentatives
Quand un événement, un déclencheur ou un automatisme invoque un webhook, ils mettent en file d’attente le travail du webhook à exécuter, mais ne l’exécutent 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, consultezSurveillance des webhooksdans la documentation destinée aux développeurs.
Création d’un webhook
Vous pouvez créer un webhook dans le Centre d’administration.
Pour créer un webhook
- Dans le中心d 'administration, cliquez sur l’icôneApplications et intégrations
dans la barre latérale, puis sélectionnezWebhooks > Webhooks.
- Cliquez surCréer un webhook.
- Pour abonner le webhook à un ou plusieurs événements Zendesk, sélectionnezÉvénements Zendesket sélectionnez un ou plusieurs types d’événement dans le menu déroulant.
- Pour connecter le webhook à un déclencheur ou un automatisme, sélectionnezDéclencheur ou Automatisme.
- Cliquez surSuivant.
- Saisissez unnomet unedescriptionpour le webhook.
- Saisissez l’URL du point de terminaisonutilisée pour intégrer le service ou système tiers. ConsultezPoints de terminaison des webhooks.
Lors de la configuration d’un webhook à intégrer avec un tiers, vous devrez peut-être consulter la documentation du tiers.
- Sélectionnez laméthode de la demandeet leformat de la demandepour le webhook.
- Sélectionnez la méthode d’authentificationpour le webhook et fournissez toutes informations supplémentaires requises. ConsultezAuthentification de votre webhook.
- (facultatif) Cliquez surAjouter un en-têtepour ajouter un en-tête personnalisé, puis saisissez unnom d’en-têteet unevaleur. Pour ajouter d’autres en-têtes (4 maximum), cliquez surAjouter un autre en-tête. ConsultezEn-têtes de webhook personnalisés.Remarque –Ne placez pas d’informations sensibles dans vos en-têtes personnalisés.
- (Facultatif) Cliquez surTester le webhookpour vérifier qu’il fonctionne correctement.
- Cliquez surCréer un webhookpour créer le webhook.
- Pour les webhooks de déclencheur ou d’automatisme, vous devez connecter le webhook à un déclencheur ou un automatisme. ConsultezConnexion d’un webhook à un déclencheur ou un automatisme Support. Une fois le déclencheur ou l’automatisme connecté, retournez à la pageCréer un webhooket cliquez surTerminer la configuration.
Une fois le webhook créé, vous pouvez consulter ses détails, ses abonnements et son activité à la page Webhooks du Centre d’administration. ConsultezGestion des webhooks.
Points de terminaison des webhooks
Les webhooks envoient des demandes à l’URL de point de terminaison spécifié lors de leur création. 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 pouvezactiver l’authentificationet transférer des données en toute sécurité.
En-têtes de webhook personnalisés
Les en-têtes personnalisés fournissent un moyen d’ajouter des informations supplémentaires à la demande qu’envoie votre webhook et peuvent simplifier la connexion avec certains services tiers qui ont des exigences d’en-têtes de webhook uniques. Notez les spécifications et limitations suivantes pour les en-têtes personnalisés :
- Pour utiliser les en-têtes personnalisés, vous devez utiliser une URL du point de terminaison sécurisée (HTTPS).
- N’incluez pas d’identifiants d’authentification ou autres informations sensibles dans les en-têtes personnalisés. Utilisez plutôt lesméthodes d’authentificationprises en charge.
- Les noms d’en-tête doivent être uniques et ne pas dépasser 128 caractères. Tous les caractères ASCII américains alphanumériques sont pris en charge, ainsi que les symboles suivants :
!
,#
,$
,%
,&
,'
,*
,+
,-
,.
,^
,_
,`
,|
et~
. - Les valeurs des en-têtes peuvent faire jusqu’à 1 000 caractères de long et prennent en charge tous les caractères ASCII américains de 0x20 à 0x7E.
Authentification d’un webhook
Si的webhook est integre aplha de术语inaison 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.
- Clé API: utilisez une clé API pour authentifier le webhook.
- Authentification de base: 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, consultezSécurité et authentification de webhook.
Pour plus de sécurité, vous pouvez aussi vérifier la signature du webhook. Pour en savoir plus, consultezVérification de l’authenticité des webhooks.
Connexion d’un webhook à un déclencheur ou un automatisme
Pour invoquer un webhook de déclencheur ou d’automatisme, vous devez d’abord le connecter à 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中心d 'administration, cliquez sur l’icôneObjets et règles
dans la barre latérale, puis sélectionnezRègles de gestion > Déclencheurs.
- Créez un nouveau déclencheurou modifiez-en un qui existe déjà en plaçant votre curseur sur l’icône d’options (
) et en cliquant surModifier.
- Pour les déclencheurs, sousActions, cliquez surAjouter une action. SélectionnezNotifier le webhooket choisissez votre webhook. Cliquez surEnregistrer.
- Dans le中心d 'administration, cliquez sur l’icôneObjets et règles
dans la barre latérale, puis sélectionnezRègles de gestion > Automatismes.
- Créez un nouvel automatismeou modifiez-en un qui existe déjà en plaçant votre curseur sur l’icône d’options (
) et en cliquant surModifier.
- Pour les automatismes, sousExécuter ces actions, cliquez sur l’icône ajouter une action (
). SélectionnezNotifications : Notifier le webhooket choisissez votre webhook. Cliquez surEnvoyer.
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中心d 'administration, cliquez sur l’icôneApplications et intégrations
dans la barre latérale, puis sélectionnezWebhooks > Webhooks.
- Trouvez le webhook dans la liste, puis cliquez sur l’icône du menu des options (
) sur la ligne du webhook et cliquez surTester le webhook.
- Dans le voletTester le webhook, sélectionnez un événement à tester. C’est un exemple de demande que vous pouvez utiliser pour tester l’URL de votre point de terminaison.
- Saisissez les détails de votre demande de test (corps, paramètres ou en-tête de la demande).
- Cliquez surEnvoyer le test. La réponse est visible dans le volet en dessous de la demande de test.
0 Commentaires
Vous devezvous connecterpour laisser un commentaire.