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 desktop e móvel, você pode usar eventos em qualquer sistema (mesmo que 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 do desktop/dispositivo 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 coletar tudo seguem.
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.
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 acionados pela API.
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.
Para obter suporte adicional, página do desenvolvedor.
Agora é hora de preencher algumas informações sobre o aplicativo de conexão API. Por razões de clareza, usamos o Zapier para explicar, mas não estamos endossando esse aplicativo em detrimento de qualquer outro. Qualquer aplicativo semelhante funcionará.
As informações usadas abaixo são universalmente necessárias em todos os aplicativos:
Adicionar Autenticação Básica
Ao usar a Autenticação básica, o clientID é o nome de usuário e o segredo do cliente é usado como a senha.
Depois de adicionar essas informações, você receberá um token de acesso.
Agora é hora de preencher os espaços em branco e usar o código JSON que chamará a notificação.
|
{ "notification": { "systemId": "<the workstation system id>", //Necessário se você tiver mais de um sistema de estações de trabalho "templateId": "<template id>", //Required "endUsersIds": ["<end user id 1>","<end user id 2>","<...>"], //Você precisa do ID do usuário final ou do ID do público (você pode usar ambos), remova o que não está usando "audiencesIds": ["<audience id 1>","<audience id 2>","","<...>"], //Você precisa do ID do usuário final ou do ID do público (você pode usar ambos), remova o que não está usando "notificationType": "<how notification will display, push v popup>", //Opcional, push padrão, remover se não estiver usando "title": "<notification title as appears in the ComCenter notification table>", //Opcional, remover se não estiver usando "runtimeTitle": "<what will appear to end-users in the Workstation list and in the push notification>", //Opcional, remover se não estiver usando "runtimeDescription": "<what will appear to end-users i in the Workstation list and in the push message>", //Opcional, remover se não estiver usando "startAt": "<start date YYYY-MM-DD hh:mm>", // Opcional, padrão agora, o fuso horário é UTC, você pode adicionar uma data e nenhuma hora, o tempo padrão é 00:00 UTC, remova o que não estiver usando "endAt": "<end date YYYY-MM-DD hh:mm>", // Opcional, padrão 30 dias a partir de agora, você pode adicionar uma data e nenhuma hora, o tempo padrão é 00:00, remova o que não estiver usando "override": [ { // Mais pares separados por vírgulas {key:value}podem ser seguidos // Por exemplo, o valor pode ser um URL passado do ServiceNow para abrir um ticket ] } } |
Aqui está um exemplo do código JSON com dados reais e poucas linhas removidas para simplificar.
| { "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”} ] } } |
Agora que temos as informações de que precisamos, vamos conectar os pontos. Para fazer a chamada (conectar os sistemas para criar e publicar novas notificações no menu desktop/dispositivo móvel da organização), você precisará do JSON mais:
