Please log in to continue
WalkMe stores your data in the region chosen during account setup.
We have data centers in the US and EU that follow local privacy and compliance laws. If you're not sure which region to select, check with your admin.
Avec l'API des notifications dans le menu de bureau/mobile, vous pouvez utiliser les événements dans n'importe quel système (même s'il ne dispose pas d'un extrait WalkMe) pour déclencher une notification dans WalkMe et automatiquement tenir vos utilisateurs à jour. Déclenchez les notifications de menu avec un appel REST vers notre Webhook de notification WalkMe.
Cet article fournira les informations nécessaires pour faire l'appel REST qui nécessite à la fois un jeton d'authentification et une charge utile JSON.
Tout système qui peut appeler une API REST peut être utilisé pour déclencher des notifications dans le menu de bureau/mobile.
Appeler l'API nécessite certaines autorisations et une configuration technique. Assurez-vous d'avoir l'accès et de pouvoir faire les opérations suivantes :
Voici ce que vous avez besoin de WalkMe pour que l'API soit déclenchée. Étapes sur la façon de rassembler tout ce qui suit.
Plus précisément, vous trouverez les informations nécessaires pour utiliser une notification JSON avec les informations suivantes :
Qu'est-ce qu'un jeton d'accès ?
Un jeton d'accès est un identifiant qui peut être utilisé par une application pour accéder à une API. Ils informent l'API que le porteur du jeton a été autorisé à accéder à une action particulière.
Le jeton d'accès authentifie l'appel API, en donnant à l'application la permission de transmettre les données de son système au menu.
À partir du panneau Créer une nouvelle clé :
À partir du panneau Détails clés :
Pour une assistance supplémentaire et pour obtenir le jeton d'autorisation : Page du développeur
Allez sur le centre de communication et créez un modèle personnalisé (Apprendre comment créer une notification) Il y a quelques choses à garder à l'esprit pour la notification que vous créez pour l'API :
Dans le cas où vous souhaitez qu'une notification soit personnalisée, soit en fonction de l'utilisateur ou de l'événement qui est déclenché, vous pouvez ajouter des valeurs dynamiques que l'API remplira automatiquement.
Dans l'image, deux exemples de valeurs sont remplacés par un texte dynamique qui sera remplacé en fonction des valeurs l'API déclenche.
C'est un exemple de notification API avec Salesforce qui est déclenché lorsqu'un nouveau lead a été assigné. Il informera le vendeur du nom de l'opportunité et du lien vers le prospect dans Salesforce.
Note : le nom de la valeur (exemple : OPP_NAME_ATTRIBUTE) doit être copié exactement dans le JSON pour qu'il puisse être remplacé.
Les étapes suivantes relieront la notification à l'API.
Pour une assistance supplémentaire Page du développeur.
Maintenant, il est temps de remplir certaines informations sur votre application de connexion API. Pour plus de clarté, nous utilisons Zapier dans le cadre de nos explications, mais nous ne la recommandons pas plus qu'une autre application. Toute application similaire fonctionnera.
Les informations utilisées ci-dessous sont universellement nécessaires sur toutes les applications :
Ajouter l'authentification de base
Lors de l'utilisation de l'Authentification de base, le clientID est le nom d'utilisateur et le secret du client est utilisé comme mot de passe.
Une fois que vous avez ajouté ces informations, vous recevrez un jeton d'accès.
Maintenant, il est temps de remplir les espaces vides et d'utiliser le code JSON qui appellera la notification.
|
{ "notification": { "systemId" : « <l'ID du système de la station de travail >», //Requis si vous avez plus d'un système de station de travail "templateId" : « <ID du modèle> », //Requise "endUsersIds" : ["<Identifiant d'utilisateur final 1>","<Identifiant d'utilisateur final 2>","<...>"], //Vous avez besoin d'un ID d'utilisateur final ou d'un ID d'audience (vous pouvez utiliser les deux), veuillez supprimer celui que vous n'utilisez pas "audiencesIds" : ["<ID d'audience 1>","<ID d'audience 2>","<...>"], //Vous avez besoin d'un ID d'utilisateur final ou d'un ID d'audience (vous pouvez utiliser les deux), veuillez supprimer celui que vous n'utilisez pas "notificationType" : « <comment la notification s'affichera, push ou popup> », //Facultatif, push par défaut, veuillez la supprimer si elle n'est pas utilisée "title" : "<titre de la notification tel qu'il s'affichera dans le tableau ComCenter>", //Facultatif, veuillez la supprimer si elle n'est pas utilisée "runtimeTitle" : "<ce qui s'affichera pour les utilisateurs finaux dans la liste Workstation et la notification push>", //Facultatif, veuillez la supprimer si elle n'est pas utilisée "runtimeDescription" : "<ce qui s'affichera pour les utilisateurs finaux dans la liste Workstation et le message push>", //Facultatif, veuillez la supprimer si elle n'est pas utilisée « startAt » : « <date de début YYYY-MM-DD hh:mm> », // Facultatif, par défaut en ce moment, le fuseau horaire est UTC, vous pouvez ajouter une date sans heure, l'heure par défaut est 00:00 UTC, supprimez tout ce que vous n'utilisez pas "endAt" : « <date de fin YYYY-MM-DD hh:mm> », // Facultatif, par défaut 30 jours à partir de maintenant, vous pouvez ajouter une date sans heure, l'heure par défaut est 00:00, supprimez tout ce que vous n'utilisez pas "override": [ { // Plus de paires de virgules séparées {key:value}peuvent suivre // Par exemple, la valeur pourrait être une URL qui est passée de ServiceNow pour ouvrir un ticket ] } } |
Voici un exemple de code JSON avec de vraies données et quelques lignes supprimées pour le rendre plus simple.
| { "notification": { "systemId": "bcf4c7f5682b4aa6875a0fc9bdfa21ca", "templateId": "1e5afe51-2d2a-4b22-a60a-cf2d6c01d726", "endUsersIds": ["name@email.com"], "runtimeTitle" : "API Test 3", "notificationType": "Push", “override”: [ {“key”: “URL”, “value”: “www.someurl.com”} ] } } |
Maintenant que nous avons les informations dont nous avons besoin, connectons les points. Pour passer l'appel (connectez les systèmes pour créer et publier de nouvelles notifications dans le menu de bureau/mobile de votre organisation), vous aurez besoin de votre JSON plus :
