Configurar um evento de webhook

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 4 min. de leitura

    • Configure um evento de API de webhook na tabela de configuração do provedor para permitir que os fornecedores de crachá compartilhem os dados de crachá coletados de tabelas de crachá usando o evento de webhook.

    Antes de Iniciar

    Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Os dados de crachá (JSON) são processados usando o explorador de REST APIs ServiceNow. Um ou vários registros de dados de crachá brutos (carga útil) podem ser compartilhados e processados usando o explorador de REST APIs. O evento de webhook para crachá de dados é carregado na tabela Eventos do conector em um ou vários registros JSON. Vários registros são enviados como uma matriz. Para obter mais informações, consulte Análise de participação.

    Procedimento

    1. Navegar até Todos > Conectores do Workplace > Configurações do Provedor.
    2. Selecione Criar novo.

      No formulário, preencha os campos.

      Tabela 1. Formulário Configuração do provedor
      Campo Descrição
      Nome Nome da configuração do provedor.
      Tipo de origem Origem de onde os dados de crachá são coletados e carregados na tabela de participação do funcionário de destino.

      Selecione Webhook para configurar o evento de webhook.
      Nome do parâmetro do token

      O nome do parâmetro dotoken e o valor do token são um par de chave-valor secreto, que é usado para autenticar a chamada de API do sistema de crachá do fornecedor para a aplicação Conectores para local de trabalho. Ambos os sistemas têm o valor de nome de token. Usando o nome do token, a aplicação autentica a solicitação de API.
      Valor do token O valor do token é a chave secreta usada pelo fornecedor do crachá ao chamar o evento de API para permitir que o servidor autentique a solicitação de API.
      Ativo Opção para indicar que a configuração do provedor está Ativa.
      Configuração do Conector Opção para pesquisar e selecionar o ícone da lista de pesquisa ( Ícone da lista de pesquisa.) para selecionar Identificação.

      Para obter mais informações, consulte Configurar um conector de spoke.
      URL do Retorno de Chamada Opção para selecionar o ícone do URL de retorno de chamada ( íconedo URL de retorno de chamada) para bloquear ou editar o URL de retorno de chamada.
    3. Selecione Atualizar.
    4. Selecione o evento de webhook recém-criado.

      O botão Gerar URL de retorno de chamada está disponível para gerar um URL de retorno de chamada para a solicitação de REST API.

      Configuração do provedor mostrando o evento de webhook com o botão Gerar URL de retorno de chamada.

    5. Como fornecedor de crachá, compartilhe os dados de crachá no formato JSON navegando até Todos > Serviços web do sistema > REST > Explorador de REST API.
    6. Na página do Explorador de REST API, selecione o seguinte:
      • Namespace: na lista suspensa, selecione sn_wsd_wc
      • Nome da API: webhook do conector do local de trabalho
      • Versão da API: v1
    7. Na página de evento do webhook do conector do local de trabalho, forneça os seguintes valores:
      • token_name: nome do parâmetro de token usado na etapa 2. O valor do nome do token é usado por fornecedores de crachá para compartilhar os dados de crachá (JSON) com Conectores para local de trabalho. Os dados brutos (carga útil ou dados de crachá) são processados e carregados na tabela Eventos do conector.
      • ni.nolog.id: copie o ID do sistema do webhook criado na etapa 2 e cole-o. Selecione o ícone de menu de ações adicionais (ícone de menu de ações adicionais.) no painel.
      • token_value: valor de token fornecido na etapa 2. O valor de token é a chave secreta usada pelo fornecedor de crachá ao chamar o evento de API para permitir que o servidor autentique a solicitação de API.
      1. No corpo da solicitação de API, selecione Bruto e copie os dados de crachá (carga útil) no formato JSON.
        Esses dados de crachá são coletados de sensores de crachá.
      2. Selecione "Enviar".
        Se o Código de resposta for 200 OK e o resultado da resposta for Success, os dados de crachá serão carregados na tabela Eventos do conector.
        • A tabela Eventos do conector (sn_wsd_wc_connector_events) carrega os dados de crachá compartilhados pelos fornecedores de crachá. O Estado dos dados de crachá é Novo quando é carregado pelo Explorador de REST APIs.
        • Os registros de dados do provedor de webhook do processo de trabalho programado são executados a cada minuto para carregar os dados de crachá da tabela de eventos do conector (dados com o estado Novo) para a tabela de dados de participação do funcionário.
      O trabalho programado obtém os dados de origem do evento do Webhook para transformar os dados no formato necessário e, em seguida, colocá-los na tabela de dados de participação do funcionário de destino.
      Nota:
      Para acessar os Conectores para local de trabalho trabalhos programados, navegue até Todos > Definição do Sistema > Trabalhos programados. Pesquise conectores para local de trabalho na coluna Aplicação. Dois trabalhos programados estão disponíveis para Conectores para local de trabalho.
      • Registros de dados do provedor de processo: lê dados de dados de crachá do fornecedor (tabela de origem). Depois de processar os dados de crachá, o registro os carrega na tabela Dados de participação do funcionário (tabela de destino). Para obter mais informações, consulte Configurar dados da tabela de crachá.
      • Processar registros de dados do provedor de webhook: lê dados da tabela Eventos do conector. Processa os dados de evento do webhook e os carrega na tabela Dados de participação do funcionário (tabela de destino).
      • Os dados são carregados na tabela Dados de participação do funcionário. O estado dos dados de crachá na tabela Eventos do conector muda para Processado.
      • Na tabela Dados de participação do funcionário, os dados são carregados na tabela Análise de participação.
        Nota:
        Os registros de dados de crachá na tabela Eventos do conector com o estado Processado são limpos após dois dias a partir da data de criação ou da data atual pela tabela Eventos do conector [sn_wsd_wc_connector_events]. Os dados no estado Erro são limpos após sete dias a partir da data de criação. Os dados no estado Novo não são limpos.