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.
Mit der Benachrichtigungs-API für Desktop- und Mobilmenüs können Sie Ereignisse in jedem System verwenden (auch wenn es kein WalkMe-Snippet enthält), um eine Benachrichtigung in WalkMe auszulösen und Ihre Benutzer automatisch auf dem Laufenden zu halten. Menübenachrichtigungen mit einem REST-Aufruf an unseren WalkMe-Benachrichtigungs-Webhook auslösen.
Dieser Artikel enthält die Informationen, die für den REST-Aufruf erforderlich sind, der sowohl ein Authentifizierungs-Token als auch eine JSON-Nutzlast erfordert.
Jedes System, das eine REST-API aufrufen kann, kann verwendet werden, um Benachrichtigungen im Desktop-Menü oder im mobilen Menü auszulösen.
Für den Aufruf der API sind einige Berechtigungen und technische Einstellungen erforderlich. Stellen Sie sicher, dass Sie Zugriff haben und Folgendes tun können:
Folgendes benötigen Sie von WalkMe, um die API zu aktivieren. Nachfolgend erfahren Sie, wie Sie alles erfassen können.
Insbesondere finden Sie hier die notwendigen Informationen, um eine JSON-Benachrichtigung mit den folgenden Informationen zu verwenden:
Was ist ein Zugriffstoken?
Ein Zugriffstoken ist eine Anmeldeinformation, das von einer Anwendung zum Zugriff auf eine API verwendet werden kann. Sie informieren die API, dass der Inhaber des Tokens berechtigt ist, auf eine bestimmte Aktion zuzugreifen.
Das Zugriffstoken authentifiziert den API-Aufruf und erteilt der Anwendung die Berechtigung, Daten aus ihrem System an das Menü zu übergeben.
Gehen Sie zur Konsole
Wählen Sie die Kategorie Admin Center
Wählen Sie Zugriffsverwaltung aus
Wählen Sie die Seite API-Schlüssel aus.
Klicken Sie auf Neuen Schlüssel erstellen
Im Bedienfeld „Create new key“:
Im Bedienfeld „Key Details“:
Für zusätzlichen Support und um das Authentifizierungs-Token zu erhalten: Seite der Entwickler
Wechseln Sie zum Kommunikationszentrum und erstellen Sie eine benutzerdefinierte Vorlage (Erstellen einer Meldung) Bei der Meldung, die Sie für die API erstellen, sind einige Dinge zu beachten:
Wenn Sie möchten, dass eine Benachrichtigung entweder für den Benutzer oder für das Ereignis personalisiert wird, das ausgelöst wird, können Sie dynamische Werte hinzufügen, die von der API automatisch ausgefüllt werden.
In der Abbildung sehen Sie zwei Beispiele für Werte, die mit dynamischem Text überschrieben werden, der je nach den Werten, die die API auslöst, ersetzt wird.
Dies ist ein Beispiel für eine API-Benachrichtigung mit Salesforce, die ausgelöst wird, wenn ein neuer Lead zugewiesen wurde. Der Vertriebsmitarbeiter wird über den Namen der Verkaufschance und den Link zum Lead in Salesforce informiert.
Die folgenden Schritte verbinden die Benachrichtigung mit der 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