Guide d'intégration Zendesk V1

Zendesk est un système de gestion de tickets Web très populaire. Ce guide vous explique comment utiliser la fonctionnalité intégrée de Zendesk pour l'intégrer à PagerDuty. Cela vous permet d'envoyer des notifications à votre équipe même en dehors des heures de bureau. Le système PagerDuty vous permet de définir comment et quand les membres de votre équipe doivent être informés. Vous pouvez également configurer une analyse des e-mails facultative et une intégration bidirectionnelle pour permettre à Zendesk de résoudre automatiquement les incidents PagerDuty et pour permettre à PagerDuty de laisser des notes internes sur les tickets Zendesk lorsque des actions sont entreprises sur l'incident PagerDuty correspondant. Les étapes de configuration de l'intégration bidirectionnelle sont décrites après l'intégration de base de Zendesk à PagerDuty , ci-dessous.

Si vous rencontrez des difficultés pour terminer l'installation, veuillez Contactez-nous .

Version :

Ce guide concerne notre intégration Zendesk V1, une version héritée.

Notre Intégration Zendesk v3 est la version la plus récente. Intégration Zendesk v2 est également disponible.

Dans PagerDuty

1. Accéder à Services → Annuaire des services .
2. Sur la page Annuaire des services :
   • Si vous créez un nouveau service pour votre intégration, cliquez sur +Nouveau service .
   • Si vous ajoutez votre intégration à un service existant, cliquez sur le nom du service auquel vous souhaitez ajouter l'intégration. Cliquez ensuite sur le bouton Intégrations onglet et cliquez sur le Ajouter une nouvelle intégration lien.
3. Sélectionnez votre application dans la liste Type d'intégration menu et entrez un Nom de l'intégration .Si vous créez un nouveau service pour votre intégration, dans Paramètres généraux , entrez un Nom pour votre nouveau service. Ensuite, configurez le Paramètres des incidents et Comportement en cas d'incident pour votre nouveau service.
4. Cliquez sur le Ajouter un service ou Ajouter une intégration pour enregistrer votre nouvelle intégration. Vous serez redirigé vers la page de votre service.
5. Copiez le Courriel d'intégration pour votre nouvelle intégration.

Dans Zendesk

Configuration d'une cible de courrier électronique

1. Cliquez sur le Engrenage d'administration dans le coin inférieur gauche de l'interface utilisateur Zendesk.
2. Sous PARAMÈTRES Cliquez sur Prolongations.
   
3. Cliquez sur   le Objectifs onglet puis sélectionnez ajouter une cible .
4. Localisez l'icône pour Cible de courrier électronique et cliquez dessus.
5. Remplissez le Titre , Adresse email (à partir de votre intégration), et Sujet ligne. Le sujet peut utiliser Zendesk espaces réservés . Le sujet est ce que vous verrez dans votre alerte PagerDuty . Remarque : l'adresse e-mail correspond à l'adresse e-mail d'intégration que vous avez créée précédemment dans PagerDuty. Si vous utilisez l'option d'analyse des e-mails et/ou d'intégration bidirectionnelle décrite plus loin dans ce guide et en suivant nos exemples d'analyse des e-mails, ajoutez des parenthèses autour de l'espace réservé à l'ID de ticket, par exemple :
   

    ({{ticket.id}}) 

   devrait être utilisé plutôt que simplement

    {{ticket.id}} 

   Ceci est illustré dans l'exemple ci-dessous, mais est facultatif si vous utilisez uniquement l'intégration Zendesk unidirectionnelle (incidents Zendesk envoyés à PagerDuty, pas de résolution automatique dans PD ou mises à jour des tickets ZD depuis PD).
   

6. Modifiez la liste déroulante en Créer une cible et cliquez Soumettre .

Configuration d'un déclencheur

1. Cliquez sur le Engrenage d'administration dans le coin inférieur gauche de l'interface utilisateur Zendesk.
   
2. Sous RÈGLES COMMERCIALES Cliquez sur Déclencheurs .
3. Cliquez sur ajouter un déclencheur .
4. Entrez un Titre du déclencheur et ajustez les conditions dans lesquelles vous souhaitez déclencher une alerte PagerDuty . L'exemple ci-dessous déclenchera une alerte PagerDuty à chaque fois qu'un nouveau ticket Zendesk est créé, mais vos conditions peuvent varier. Effectuez ces actions , sélectionner Notifications : notifier la cible et sélectionnez la cible que vous avez créée précédemment. Saisissez un message que vous souhaitez inclure dans la notification PagerDuty . Ce champ est également personnalisable avec Zendesk espaces réservés . Cliquez sur Ajouter un déclencheur lorsque vous avez terminé votre configuration.
   Vous trouverez ci-dessous le texte que nous avons utilisé pour l'exemple de message :

    Un nouveau ticket Zendesk (#{{ticket.id}}) a été créé. Pour consulter le statut du ticket et ajouter des mises à jour, suivez le lien ci-dessous :http://{{ticket.url}} {ticket.comments_formatted}} 

Désormais, lorsque vous recevez un ticket dans Zendesk, un incident correspondant sera également déclenché dans PagerDuty.

Mise en place de la gestion des e-mails et de l'intégration bidirectionnelle

Guide de masquage

———DÉBUT DU GUIDE DE GESTION DES E-MAILS———
Introduction De nombreux clients utilisent PagerDuty en conjonction avec Zendesk pour informer les équipes ou les individus si un ticket a été ouvert, change de statut ou est hors SLA. La fonctionnalité de gestion des e-mails vous permettra de résoudre automatiquement les incidents PagerDuty lorsqu'un ticket Zendesk change de statut (c'est-à-dire qu'un ticket est fermé). Cet article explique comment créer des règles de gestion des e-mails personnalisées pour les incidents provenant d'une intégration de messagerie Zendesk. Gardez à l'esprit que vous pouvez choisir de créer vos règles différemment en fonction de votre cas d'utilisation. Examen des déclencheurs et des modèles d'e-mails Zendesk Pour résoudre automatiquement les incidents dans PagerDuty, vous devrez compléter le Intégration PagerDuty/Zendesk et créez à la fois une cible e-mail pour atteindre votre intégration PagerDuty , ainsi que des déclencheurs Zendesk. Zendesk déclenche des déclencheurs lorsque des événements spécifiques se produisent (c'est-à-dire qu'un ticket est ouvert ou résolu). Ces déclencheurs peuvent ensuite envoyer des e-mails à partir d'un modèle personnalisable. Vous utiliserez ces e-mails pour créer une clé d'incident qui indique à PagerDuty quand ajouter de nouveaux incidents à un incident existant. Création de déclencheurs et de modèles d'e-mails, Vous trouverez ci-dessous deux déclencheurs Zendesk que nous utiliserons pour créer des règles de gestion des e-mails : le premier se déclenche lorsqu'un ticket est ouvert et le second lorsqu'un ticket est résolu. Si vous avez suivi les exemples du guide d'intégration ci-dessus, votre cible d'e-mail qui atteint votre intégration Zendesk PagerDuty est configurée de manière à ce que le numéro d'ID de ticket apparaisse toujours dans la ligne d'objet. Nous utiliserons ultérieurement cet ID de ticket pour créer notre clé d'incident. Vous pouvez également inclure l'ID de ticket dans le corps de l'e-mail, comme nous l'avons indiqué ci-dessous. Exemples de déclencheurs Zendesk Le ticket Zendesk (#{{ticket.id)}}) a été créé par {{current_user.organization.name}}. Pour consulter le statut du ticket et ajouter des mises à jour, suivez le lien ci-dessous :
{{ticket.link}}Le ticket Zendesk (#{{ticket.id}}) a été marqué comme résolu. Pour consulter le statut du ticket et ajouter des mises à jour, suivez ce lien https://{{ticket.link}}.

Exemples d'e-mails provenant de déclencheurs Zendesk

Première règle – Déclencher un incident dans PagerDuty

Maintenant que nos déclencheurs Zendesk sont configurés, nous devons créer des règles de gestion des e-mails dans PagerDuty. Dans notre première règle, nous allons définir les conditions qui doivent être remplies pour créer un incident dans PagerDuty (c'est-à-dire qu'un ticket est créé dans Zendesk).

Dans cet exemple, un incident doit être déclenché si le corps de l'e-mail contient les mots 'créé' ET 'Zendesk'. Assurez-vous que les conditions que vous utilisez pour l'e-mail déclencheur ne sont pas les mêmes que celles que l'on trouverait dans un e-mail de récupération. Notez également que les règles de gestion des e-mails sont sensibles à la casse. Par conséquent, les e-mails contenant les mots 'créé' ne se déclencheront pas pour une règle indiquant 'Créé', ainsi que l'inverse.

Ensuite, nous allons créer la clé d'incident qui sera utilisée pour ajouter de nouveaux e-mails aux e-mails existants. La clé d'incident doit toujours être un identifiant unique qui apparaît à la fois dans l'e-mail de déclenchement et dans l'e-mail de récupération. Dans ce cas, nous indiquerons à PagerDuty d'ajouter des e-mails sur l'ID de ticket Zendesk, qui, selon la cible de l'e-mail mentionnée précédemment, se trouve dans la ligne d'objet de l'e-mail entre les parenthèses (ID de ticket).

Deuxième règle – Résoudre un incident dans PagerDuty

Dans la deuxième règle, nous indiquerons à PagerDuty de résoudre les incidents contenant résolu ET Zendesk dans le corps de l'e-mail.

Nous utiliserons la même clé d’incident que dans la première règle, afin que PagerDuty sache que ces e-mails sont liés au même incident et qu’il doit être résolu.

Que faire si les e-mails d’incident ne correspondent pas aux règles ?

Enfin, nous allons préciser ce que PagerDuty doit faire avec un e-mail s'il ne répond pas aux règles établies dans les conditions de la règle : créer un incident générique ou le supprimer. Si vous avez sélectionné Créer un incident générique, l'incident sera quand même créé mais ne correspondra à aucune de vos règles et ne pourra pas être résolu. Vous verrez également la clé de l'incident extraite comme ligne d'objet complète, plutôt que l'ID du ticket ou d'autres critères que vous avez spécifiés dans votre règle de déclenchement.

Règles de gestion des tests

Il est conseillé de vérifier si vos règles de gestion des e-mails sont correctement configurées. Pour ce faire, transférez un e-mail pour déclencher un incident, ainsi qu'un e-mail pour résoudre un incident, à l'adresse Courriel d'intégration adresse affichée sur le service Intégrations onglet.Si vos règles de gestion sont correctement configurées, le journal d'activité des incidents affichera que l'incident a été déclenché puis résolu.

Félicitations ! Vous pouvez désormais déclencher et résoudre automatiquement des incidents par e-mail pour Zendesk.

Appendice

Comment créer des clés d’incident à l’aide de regex ?

Si vous souhaitez découvrir comment créer une clé d'incident pour les intégrations Zendesk à l'aide de regex, consultez l'article suivant : Comment utiliser un groupe de capture lors de la création d'une clé d'incident.

---------FIN DU GUIDE DE GESTION DES E-MAILS---------

Les instructions ci-dessus permettent de configurer Zendesk pour envoyer des notifications à PagerDuty lorsqu'un ticket est créé, mais vous pouvez également configurer Zendesk pour résoudre automatiquement les incidents PagerDuty et configurer PagerDuty pour commenter les tickets Zendesk lorsque l'incident correspondant est déclenché, reconnu ou résolu. Pour que Zendesk résolve automatiquement les incidents PagerDuty , vous pouvez suivre notre guide de gestion des e-mails Zendesk ci-dessus. Si vous suivez exactement nos exemples de gestion des e-mails, assurez-vous de modifier votre cible d'e-mail Zendesk et d'ajouter des parenthèses autour de l'espace réservé à l'ID de ticket, par exemple :

 ({{ticket.id}}) 

devrait être utilisé plutôt que simplement

 {{ticket.id}} 

(Voir Configuration d'une cible de courrier électronique sous Dans Zendesk ci-dessus pour une capture d'écran de cette configuration).

Pour utiliser l'intégration bidirectionnelle, vous devez disposer d'un Héroku votre compte est également déjà configuré. Une fois que vous avez configuré votre intégration Zendesk de base, vos règles de gestion des e-mails et votre compte Heroku :

• Dans PagerDuty, confirmez que vos règles de gestion des e-mails extraient les ticket_id (en tant que champ personnalisé) et qu'ils correspondent aux informations qui seront envoyées depuis votre déclencheur Zendesk. Vos règles peuvent différer légèrement, mais veuillez noter que ticket_id est nécessaire pour l'intégration bidirectionnelle. Vous devrez donc vous assurer qu'il est envoyé à PagerDuty depuis Zendesk et extrait dans vos règles de gestion.
• Vous aurez également besoin de l'étiquette pd_integration ajouté aux nouveaux tickets créés dans votre compte Zendesk. Vous pouvez l'ajouter manuellement à chaque ticket, mais nous avons créé un déclencheur pour cet exemple qui notifiera PagerDuty et ajoutera cette balise lorsqu'un nouveau ticket est créé. Nous avons également indiqué ici où se trouve le ticket_id (Espace réservé Zendesk :   {{ticket.id}} ) est défini dans le message déclencheur. Le déclencheur ci-dessous suit les exemples présentés plus haut dans ce guide. Cependant, vous pouvez personnaliser ce message à condition que l'ID du ticket soit inclus dans le message et extrait correctement.
• Une fois vos règles et déclencheurs configurés dans PagerDuty et Zendesk, visitez le lien suivant et cliquez sur Déployer sur Heroku : https://github.com/ryanhoskin/pd2zendesk . Cela vous invitera à créer l'application dans votre compte Heroku, où vous pourrez remplir les variables d'environnement : NOM_D'UTILISATEUR_ZENDESK (votre e-mail de connexion Zendesk), Jeton d'API ZENDESK (visite Admin > Canaux > API dans Zendesk pour afficher/créer des jetons), SOUS-DOMAINE ZENDESK , PAGERDUTY_API_TOKEN (à partir de votre page d'accès API dans PagerDuty), et PAGERDUTY_SOUS-DOMAINE . Une fois que vous les avez remplis, cliquez sur Déployer.
• Quand vous voyez le message Votre application a été déployée avec succès , clic droit Voir le et copiez l'adresse du lien, ou cliquez sur Voir il et copiez l'URL depuis la barre d'adresse de votre navigateur. Dans votre service Zendesk PagerDuty , cliquez sur Intégrations onglet et cliquez sur Ajouter une extension ; pour le Type d'extension sélectionner Webhook générique , puis entrez un nom pour votre webhook et collez l'URL Heroku que vous avez copiée dans le URL du point de terminaison champ. Avant d'enregistrer le webhook, ajoutez pd2zendesk.php jusqu'à la fin de votre URL, afin que le produit fini se lise https://[VOTRE-NOM-D'APPLICATION-HEROKU].herokuapp.com/pd2zendesk.php . Cliquez Sauvegarder . Vous pouvez maintenant tester votre intégration.
• Pour tester : créez un nouveau ticket Zendesk. Vous pouvez garder le ticket ouvert pour voir les modifications se mettre à jour automatiquement au fur et à mesure qu'elles se produisent. Ajoutez le pd_integration balise si vous n'avez pas encore configuré votre déclencheur pour l'ajouter, et une fois la balise ajoutée, vous devriez voir une note interne sur votre ticket indiquant que le ticket a été déclenché dans PagerDuty, avec un lien vers l'incident.
• Reconnaître l'incident dans PagerDuty. Vous verrez une note interne sur le ticket Zendesk indiquant que l'incident PagerDuty a été reconnu .
• Résoudre l'incident dans PagerDuty. Vous verrez une note interne sur le ticket Zendesk indiquant que l'incident PagerDuty a été résolu .
• FACULTATIF : Vous pouvez personnaliser cette intégration en ajoutant des déclencheurs supplémentaires pour effectuer différentes actions sur vos tickets Zendesk, en fonction du texte de commentaire ajouté par l'intégration PagerDuty . Vous devriez explorer les options lors de la création d'un déclencheur Zendesk pour une vue d'ensemble de ce qui est possible, voici quelques idées :
  • Définir le statut du ticket sur ouvrir , en attente , en attente , ou résolu basé sur « Ce ticket a été reconnu ' ou 'Ce ticket a été résolu ' texte du commentaire.
  • Attribuer le ticket à un Zendesk spécifique agent basé sur le texte du commentaire.
  • Configurer Zendesk Mots clés ou priorité basé sur le texte du commentaire.

FAQ

Les tickets Zendesk résoudront-ils automatiquement les incidents PagerDuty ?

Oui, après avoir suivi les étapes de la section Guide de gestion des e-mails Zendesk de cet article.

Comment configurer Zendesk pour qu'il fonctionne avec plusieurs services PagerDuty ?

Pour utiliser Zendesk avec plusieurs services PagerDuty , vous devez configurer plusieurs services PagerDuty avec des cibles de messagerie Zendesk et des déclencheurs spécifiques à chaque service différent. Si vous rencontrez des problèmes avec l'intégration, veuillez contacter notre équipe de soutien pour obtenir de l'aide.

Pour Zendesk, j'ai le forfait Essential ; puis-je utiliser cette intégration ?

Cette intégration fonctionne uniquement avec la fonctionnalité Zendesk permettant de notifier les cibles externes ; la notification des cibles externes n'est pas incluse dans le plan Essential, mais elle est incluse dans les plans Team, Professional et Enterprise.