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.
Com a API de Notificações do menu para desktop e dispositivos móveis, você pode usar eventos em qualquer sistema (mesmo que ele não tenha um snippet do WalkMe) para acionar uma notificação no WalkMe e manter seus Usuários atualizados automaticamente. Ative notificações do menu com uma chamada REST para o nosso Webhook de Notificação WalkMe.
Este artigo fornecerá as informações necessárias para fazer a chamada REST, que requer um token de autenticação e uma carga útil JSON.
Qualquer sistema que possa chamar uma API REST pode ser usado para acionar Notificações no menu desktop/móvel.
Chamar a API requer algumas permissões e configuração técnica. Certifique-se de ter acesso e poder fazer o seguinte:
Aqui está o que você precisa do WalkMe para ativar o gatilho da API. As etapas sobre como reunir tudo são as seguintes.
Especificamente, você encontrará as informações necessárias para usar uma notificação JSON com as seguintes informações:
O que é um token de acesso?
Um token de acesso é uma credencial que pode ser usada por um aplicativo para acessar uma API. Eles informam à API que o portador do token foi autorizado a acessar uma ação específica.
O token de acesso autentica a chamada de API, dando ao aplicativo permissão para passar dados do sistema para o menu.
Vá para o console
Selecione a categoria Central do Admin
Selecione Gerenciamento de acesso
Selecione a página Chaves de API
Clique em Criar Nova Chave
No painel Criar nova chave:
No painel Detalhes Chave:
Para obter suporte extra e o token de autorização: página do desenvolvedor
Vá para a Central de Comunicação e crie um modelo personalizado ( Saiba como criar uma notificação). Há algumas coisas a serem lembradas para a notificação que você cria para a API:
No caso de você querer que uma notificação seja personalizada, seja para o usuário ou para o evento que está sendo acionado, você pode adicionar valores dinâmicos que a API preencherá automaticamente.
Na imagem, há dois exemplos de valores sendo substituídos por texto dinâmico que será substituído dependendo dos valores que a API aciona.
Este é um exemplo de notificação de API com o Salesforce, que é acionada quando um novo lead é atribuído. Ele notificará o vendedor sobre o nome da oportunidade e o link para o lead no Salesforce.
As etapas a seguir conectarão a notificação à 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