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 du menu de bureau et mobile, vous pouvez utiliser les événements dans n'importe quel système (même s'il ne dispose pas d'extrait WalkMe) pour déclencher une notification dans WalkMe et tenir automatiquement 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.
Allez sur la console
Sélectionnez la catégorie Centre Admin
Sélectionnez Gestion des accès
Sélectionnez la page Clés API
Cliquez sur Créer une nouvelle clé
À 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.
Les étapes suivantes relieront la notification à l'API.
For extra support Developer page.
Now it's time to fill in some information on your API connection application. For clarity, we use Zapier to explain, but we are not endorsing this application over any other. Any similar app will work.
The information used below is universally necessary on all applications:
Add Basic Authentication
When using basic Auth, the clientID is the username and the client secret is used as the password.
Once you've added this information, you will be given an access token.
Now it's time to fill in the blanks and use the JSON code that will call the notification.
|
{ "notification": { "systemId": "<the workstation system id>", //Required if you have more than one workstation system "templateId": "<template id>", //Required "endUsersIds": ["<end user id 1>","<end user id 2>","<...>"], //You need either end-user ID or audience ID (you can use both), remove the one you aren't using "audiencesIds": ["<audience id 1>","<audience id 2>","<...>"], //You need either end-user ID or audience ID (you can use both), remove the one you aren't using "notificationType": "<how notification will display, push v popup>", //Optional, default push, remove if not using "title": "<notification title as appears in the ComCenter notification table>", //Optional, remove if not using "runtimeTitle": "<what will appear to end-users in the Workstation list and in the push notification>", //Optional, remove if not using "runtimeDescription": "<what will appear to end-users i in the Workstation list and in the push message>", //Optional, remove if not using "startAt": "<start date YYYY-MM-DD hh:mm>", // Optional, default right now, timezone is UTC, you can add a date and no time, default time is 00:00 UTC, remove whatever you are not using "endAt": "<end date YYYY-MM-DD hh:mm>", // Optional, default 30 days from now, you can add a date and no time, default time is 00:00, remove whatever you are not using "override": [ { // More comma separated {key:value} pairs can follow // For example, the value could be a URL that is passed from ServiceNow to open a ticket ] } } |
Here is an example of the JSON code with real data with few lines removed to make it simpler.
| { "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”} ] } } |
Now that we have the information we need, let's connect the dots. To make the call (connect the systems to create and publish new notifications in your organization's desktop/mobile menu), you'll need your JSON plus:
A single call supports up to 50,000 recipients