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.
Con la API de notificaciones del menú de escritorio y móvil, puedes utilizar eventos en cualquier sistema (incluso si no tiene un fragmento de WalkMe) para activar una notificación en WalkMe y mantener actualizados a tus usuarios automáticamente. Activa notificaciones del menú con una llamada REST a nuestro Webhook de notificación de WalkMe.
Este artículo proporcionará la información necesaria para realizar la llamada REST, que requiere un token de autenticación y una carga útil JSON.
Cualquier sistema que pueda llamar a una API REST se puede utilizar para activar notificaciones en el menú de escritorio o móvil.
Llamar a la API requiere algunos permisos y configuración técnica. Asegúrate de que tienes acceso y puedes hacer lo siguiente:
Esto es lo que necesitas de WalkMe para activar la API. A continuación se muestran los pasos sobre cómo recopilar todo.
Específicamente, encontrarás la información necesaria para utilizar un JSON de notificación con la siguiente información:
¿Qué es un token de acceso?
Un token de acceso es una credencial que puede ser utilizada por una aplicación para acceder a una API. Informan a la API que el portador del token ha sido autorizado a acceder a una acción en particular.
El token de acceso autentica la llamada a la API, lo que permite a la aplicación pasar datos de su sistema al menú.
Ve a la consola
Selecciona la categoría Centro de administración
Selecciona Gestión de acceso
Selecciona la página Claves API
Haz clic en Crear nueva clave
Desde el panel Crear nueva clave:
Desde el panel Detalles clave:
Para obtener soporte adicional y obtener el token de autorización: página del desarrollador.
Ve al Centro de comunicaciones y crea una plantilla personalizada (aprende a crear una notificación). Hay algunas cosas que debes tener en cuenta para la notificación que creas para la API:
En el caso de que desees que una notificación sea personalizada, ya sea para el usuario o para el evento que se está activando, puedes añadir valores dinámicos que la API completará automáticamente.
En la imagen, hay dos ejemplos de valores que se sobrescriben con texto dinámico que se reemplazará dependiendo de los valores que la API desencadene.
Este es un ejemplo de notificación de API con Salesforce que se activa cuando se ha asignado un nuevo lead. Notificará al vendedor el nombre de la oportunidad y lo vinculará al cliente potencial en Salesforce.
Los siguientes pasos conectarán la notificación con la 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