Configurar webhook bidirecional para o spoke do GitHub

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 3 min. de leitura
  • Configure o webhook para assinar GitHub com um URL de retorno de chamada ServiceNow.

    Antes de Iniciar

    • Solicite a assinatura do Integration Hub.
    • Ativar o GitHub spoke
    • Função necessária: administrador

    Criar segredo para o GitHub spoke

    Crie um segredo para incorporado na URL do webhook GitHub.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Definição do Sistema > Scripts - Segundo Plano.
    2. Insira este comando no campo de texto Executar script (JavaScript executado no servidor) :
      gs.info(GlideSecureRandomUtil.getSecureRandomString(16));
    3. Clique em Executar script.
    4. Copie e registre o segredo gerado para uso posterior.

    Registrar GitHub webhook em ServiceNow

    Registre um GitHub em ServiceNow para notificar o app ServiceNow quando determinados eventos ocorrerem em GitHub.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Webhooks do GitHub > Registros de webhook do GitHub.
    2. Clique em Nova.
    3. No formulário, preencha os campos.
      Tabela 1. Formulário Registro de webhook do GitHub
      Campo Descrição
      Nome Nome exclusivo para identificar o registro. Por exemplo, webhook do GitHub.
      Descrição Descrição do registro.
      Segredo Segredo que você gerou usando o módulo Scripts - Plano de fundo.
      Caminho GitHub caminho do webhook. Por padrão, isso é definido como api/sn_github_spoke/github_webhook_callbacks/wh_entry.
    4. Clique com o botão direito no cabeçalho do formulário e clique em Salvar.
    5. Clique em URL de retornode chamada .
      O sistema exibe a URL de retorno de chamada do Webhook e o segredo.
    6. Copie e registre a URL e o segredo do retorno de chamada do Webhook.

    Resultado

    O webhook GitHub está registrado em sua instância ServiceNow.

    Adicionar URL de retorno de chamada em GitHub

    Forneça a URL de retorno de chamada do Webhook na conta GitHub para criar o webhook.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Faça login na sua conta GitHub.
    2. Crie um webhook na sua conta da Atlassian.
    3. Insira a URL de retorno de chamada do Webhook em URL da carga e Segredo em Segredo.

      Veja o GitHub Desenvolvedor Documentação do para obter instruções sobre como criar e configurar um webhook.

      Nota:
      GitHub spoke O é compatível com carga de aplicação/json. Configure o webhook GitHub adequadamente. Veja o GitHub Desenvolvedor Documentação do para obter instruções sobre como criar e configurar um webhook.

    Resultado

    O URL de retorno de chamada é adicionado à conta GitHub. Você pode criar políticas de roteamento e subfluxos de acordo com seus requisitos. Consulte Personalizar a webhook bidirecional para obter informações sobre como criar novas políticas de roteamento e subfluxos.

    Personalizar webhook bidirecional no GitHub spoke

    Crie a política de roteamento do webhook e o subfluxo de acordo com seu requisito no GitHub spoke.

    Antes de Iniciar

    Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    A política de roteamento padrão nos módulos de políticas de roteamento do WebHook do GitHub aciona o subfluxo GitHub relevante e notifica o app ServiceNow quando determinados eventos ocorrem em GitHub. Consulte GitHub Spoke para obter informações sobre os campos GitHub compatíveis com a política de roteamento padrão e os eventos GitHub compatíveis com os subfluxos. Para usar outros campos em seu subfluxo personalizado e personalizar as condições na política de roteamento, execute estas etapas.

    Procedimento

    1. Navegar até Todos > Flow Designer > Designer.
    2. Clique em Subfluxos.
    3. Crie uma cópia do subfluxo necessário.
    4. Personalize o subfluxo necessário de acordo com seus requisitos e publique-o.
      Consulte Criação de subfluxos para obter mais informações sobre como criar e usar subfluxos e GitHub Spoke para obter informações sobre os campos GitHub compatíveis com a política de roteamento padrão e os eventos GitHub compatíveis com os subfluxos.
    5. Navegar até Webhooks do GitHub > Políticas de roteamento do WebHook do GitHub.
    6. Clique em Nova.
    7. No formulário, preencha os campos.
      Tabela 2. Formulário de decisão
      Campo Descrição
      Rótulo Rótulo exclusivo para identificar a política de roteamento.
      Resposta padrão Opção para especificar se esta é a resposta padrão. A resposta padrão é aplicável quando as condições não são atendidas.
      1. Clique no ícone de pesquisa.
      2. Selecione o subfluxo necessário na lista Documento:.
        Nota:
        Certifique-se de que o nome da tabela seja Fluxo [sys_hub_flow].
      Condição Condições a serem atendidas quando os eventos necessários ocorrerem em GitHub. Consulte GitHub Spoke para obter informações sobre os campos compatíveis.
      Resposta Subfluxo que precisa ser acionado quando as condições especificadas são atendidas.
    8. Clique em Enviar.
      Nota:
      Essas políticas de roteamento são salvas nas tabelas de decisão. Os usuários são alertados para não atualizar ou modificar diretamente os dados dessas tabelas.

    Resultado

    A política de roteamento e o subfluxo foram criados.