< Back
Welcome to the WalkMe Help Center

Please login in order to continue:

Reset password Reset EU password
Work flows better with WalkMe
Work flows better with WalkMe.
Search for anything

API de notificaciones de Estación de Trabajo

Last Updated agosto 7, 2025
Share Article Copy link to clipboard
Escritorio

Breve descripción general

Con la API de notificaciones de Workstation, puedes utilizar eventos en cualquier sistema (incluso si no tiene un fragmento de WalkMe) para activar una notificación en WalkMe y mantener automáticamente actualizados a tus usuarios. Activar notificaciones de Workstation 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.

Casos de uso

  • Muestra alertas cuando un sistema está inactivo o tiene problemas (servidores de AWS o Slack).
  • Notifica a un aprobador cuando un nuevo ticket de ServiceNow requiera su revisión.
  • Informa a los usuarios cuando su contraseña de Okta ha caducado.
  • Recuerda a los usuarios que completen su Inscripción Abierta.
  • ¡y más!

Cualquier sistema que pueda llamar a una API REST se puede utilizar para activar notificaciones en Estación de Trabajo.

Antes de comenzar...

Llamar a la API requiere algunos permisos y configuración técnica. Asegúrate de que tienes acceso y puedes hacer lo siguiente:

  • Acceso al Centro de administración para que el sistema Estación de Trabajo obtenga el token de acceso a la API.
    • Nota: si tu organización tiene más de un sistema de Workstation, tendrás que realizar llamadas a API separadas para cada sistema.
  • Aplicación para configurar y ejecutar llamadas (por ejemplo, Zapier o Postman) a la API de notificación.
    • Debes tener una aplicación que pueda realizar llamadas a API REST salientes autenticadas. Si no estás seguro de si tu organización tiene una aplicación de este tipo, ponte en contacto con tu equipo de TI para discutir las opciones.

Cómo funciona

Esto es lo que necesitas de WalkMe para activar la API. A continuación se muestran los pasos sobre cómo recopilar todo.

  1. Autenticación y creación de un token de acceso.
  2. Identificar la notificación del Centro de comunicaciones y el público objetivo.
  3. Creación de la carga útil JSON
  4. Realizar la llamada

Específicamente, encontrarás la información necesaria para utilizar un JSON de notificación con la siguiente información:

  • ID del sistema
  • ID de plantilla de notificación
  • ID de usuarios finales o ID de audiencia.
  • Tipo de notificación: ventana emergente o push
  • Título de la notificación
  • Descripción
  • Información de anulación

Autenticación y creación de un token de acceso.

¿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 a Workstation.

Crea un token de acceso

  1. Ir al Centro de administración
  2. Navega hasta la pestaña Claves API: https://admin.walkme.com/account-api-keys
  3. Haz clic en Crear nueva clave

Desde el panel Crear nueva clave:

  1. Nombra la clave
    • Consejo: indica el propósito de la clave en el nombre para ayudarte a recordarla más tarde.
  2. Activa la API de notificación.
  3. Selecciona Escribir en el menú desplegable.
  4. Haz clic en Crear

Desde el panel Detalles clave:

  1. Copia el ID del cliente y el Secreto del cliente.
Guarda el secreto del cliente

No volverás a ver el Secreto, así que guárdalo en un lugar accesible, lo volverás a necesitar pronto.

Token de autenticación

Para obtener soporte adicional y obtener el token de autorización: página del desarrollador.

Notificación de ComCenter e ID de audiencia.

Crea una plantilla de notificación

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:

  • La notificación solo puede tener un botón.
  • La acción del botón solo puede utilizar la Acción del Enlace.
    • Puedes utilizar enlaces dinámicos o permalinks de WalkMe.

No puedes editar la notificación después de configurar la API, así que asegúrate de estar satisfecho con tu notificación.

Opcional: añade reglas de anulación en la plantilla.

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 active la API.

La oportunidad ###OPP_NAME_ATTRIBUTE### necesita información adicional. Haz clic en el botón a continuación para que WalkMe te guíe a través de tus actualizaciones. Al hacer clic en el botón, te lleva a ###URL###

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 se vinculará al lead en Salesforce.

  1. ###OPP_NAME_ATTRIBUTE### se reemplazará por el nombre de la oportunidad en Salesforce.
  2. ###URL### se reemplazará por una URL real, lo que permitirá una acción personalizada para cada usuario, cada vez que se active la API.

Nota: el nombre del valor (ejemplo: OPP_NAME_ATTRIBUTE) debe copiarse exactamente en el JSON para que pueda ser reemplazado.

Copia los valores requeridos

Los siguientes pasos conectarán la notificación con la API.

Copia el ID de plantilla personalizada que creaste.

  1. Ve a CommCenter
  2. Haz clic en Nueva notificación
  3. En Plantillas personalizadas>, pasa el cursor sobre la esquina de la notificación.
  4. Haz clic en el icono de copia para copiar el ID en el portapapeles.
    • Ejemplo: 75cfcba6-c320-42cb-938e-4c2bd08a43a3.

Copia el ID de audiencia objetivo.

ID del usuario final vs Audiencia.

Utilizar una audiencia es más eficiente, pero también puedes dirigirte a hasta 100 usuarios en función de su ID de usuario final. Recomendamos crear una audiencia si planeas utilizar más de 10 ID de usuario final.

  1. Ve a Audiencias
  2. Pasa el cursor sobre la audiencia, haz clic en el menú de 3 puntos a la derecha y selecciona Copiar ID.
    • Puedes añadir varias audiencias al JSON.
    • ID de ejemplo: cf0bd4c1-86fd-4c79-a46a-c730d6789e63.

Añade información a la aplicación de conexión API.

Para obtener soporte adicional, la página de desarrollador.

Ahora es el momento de introducir algo de información sobre la aplicación de conexión a API. Para mayor claridad, utilizamos Zapier para explicar, pero no estamos respaldando esta aplicación sobre ninguna otra. Cualquier aplicación similar funcionará.

La información que se utiliza a continuación es universalmente necesaria en todas las aplicaciones:

  1. URL = https://api.walkme.com/accounts/connect/token
  2. Tipo de carga = (Content-Type) application/x-www-form-urlencoded
  3. Data = grant_type → client_credentials

Añade autenticación básica

Al utilizar la autenticación básica, el ID del cliente es el nombre de usuario y el secreto del cliente se utiliza como contraseña.

  1. ID del cliente | Secreto del cliente (copiado del Centro de administración)
    • Ejemplo
      0o234234234UqD5d7 | JVnD346346346345asfgasgbPt_4T7h2_

Una vez que hayas añadido esta información, se te dará un token de acceso.

  1. Copia tu token de acceso.
Si estás utilizando Zapier, puedes eliminar este paso después de haber copiado el token.

Actualiza el código JSON

Ahora es el momento de rellenar los espacios en blanco y utilizar el código JSON que llamará a la notificación.

{

"notificación": {

"systemId": "<el identificador del sistema de la estación de trabajo>", //Obligatorio si tienes más de un sistema de estaciones de trabajo.

"templateId": "template id", //Requerido

"endUsersIds": ["<ID del usuario final 1>","<ID del usuario final 2>","<...>"], //Necesitas el ID del usuario final o el ID de la audiencia (puedes utilizar ambos), elimina el que no estás utilizando.

"audiencesIds": ["<ID de audiencia 1>","<ID de audiencia 2>","<...>"], //Necesitas el ID del usuario final o el ID de la audiencia (puedes utilizar ambos), elimina el que no estás utilizando.

"notificationType": "cómo se mostrará la notificación, push v popup", //Opcional, push predeterminado, elimina si no se utiliza.

"title": "<el título de la notificación tal y como aparece en la tabla de notificaciones de ComCenter>", //Opcional, elimina si no se utiliza.

"runtimeTitle": "<lo que aparecerá para los usuarios finales en la lista de Workstation y en la notificación push>", //Opcional, elimina si no se utiliza.

"runtimeDescription": "lo que aparecerá para los usuarios finales en la lista de Workstation y en el mensaje push", //Opcional, elimina si no se utiliza.

"startAt": "fecha de inicio YYYY-MM-DD hh:mm", // Opcional, el predeterminado en este momento, la zona horaria es UTC, puedes añadir una fecha y ninguna hora, la hora predeterminada es 00:00 UTC, elimina lo que no estés utilizando.

"endAt": "fecha de fin YYYY-MM-DD hh:mm", // Opcional, 30 días por defecto a partir de ahora, puedes añadir una fecha y sin hora, la hora predeterminada es 00:00, elimina lo que no estés utilizando.

"override": [

{
"key" : "<la cadena de marcador de posición que se debe reemplazar en la plantilla de notificación>",
"value" : "<el valor que se debe poner en la notificación en lugar del marcador>"
}

// Pueden seguir más pares separados {key:value}por comas.

// Por ejemplo, el valor podría ser una URL que se pasa desde ServiceNow para abrir un ticket.

]

}

}
Elimina las líneas que no estás utilizando.

Si hay líneas opcionales que no estás completando, elimínalas del código final para evitar errores.

End user and Audience ID

endUsersIds y audiencesIds son matrices y deben ser arreglos. escrito con corchetes [], y cada cadena debe ser un elemento. separados por una coma ["<id1>","<id2>","<...>"]

La zona horaria predeterminada es UTC.

La zona horaria predeterminada es UTC, pero si deseas enviar la notificación según una zona horaria diferente, puedes añadir o restar de UTC. Por ejemplo, "2023-05-10T11:30:00+03:00" se enviaría a UTC+3 y la hora correspondiente en UTC sería "08:30:00" (restando 3 horas a la hora dada).

Aquí hay un ejemplo del código JSON con datos reales con pocas líneas eliminadas para hacerlo más simple.

{
"notificación": {
"systemId": "bcf4c7f5682b4aa6875a0fc9bdfa21ca",
"templateId": "1e5afe51-2d2a-4b22-a60a-cf2d6c01d726",
"endUsersIds": ["name@email.com"],
"runtimeTitle": "API Test 3",
"notificationType": "Push",
"override": [
{"clave": "URL",
“value”: “www.someurl.com”}
]
}
}

Haz la llamada

Ahora que tenemos la información que necesitamos, conectemos los puntos. Para realizar la llamada (conectar los sistemas para crear y publicar nuevas notificaciones en la Estación de Trabajo de tu organización), necesitarás tu JSON más:

Notas técnicas

  • Solo admitimos el envío de 1 notificación cada 20 segundos.

Was this article helpful?

Yes No
Yes
No
Thanks for your feedback!
Escritorio

Related Articles

×