Configurar um webhook

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

    • Configure a aplicação webhook para receber as atualizações necessárias do Jenkins na sua instância ServiceNow.

    Antes de Iniciar

    Função necessária: administrador

    Criar chave de autorização para o Spoke do Jenkins v2

    Crie uma chave de autorização para autorizar solicitações do Jenkins.

    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(32));
    3. Clique em Executar script.
    4. Copie e registre o valor gerado para uso posterior.
      Segredo do cliente ou chave de autorização

    Fornecer chave de autorização para o webhook

    Autorize as solicitações do Jenkins fornecendo a chave de autorização para o webhook na sua instância ServiceNow.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Jenkins v2 > Detalhes de cliente do Webhook.
    2. Clique em Nova.
    3. No formulário, preencha estes valores:
      Tabela 1. Formulário de detalhes do cliente do webhook do Jenkins
      Campo Descrição
      Chave de Autorização Chave de autorização que você gerou. Consulte Criar chave de autorização para o Spoke do Jenkins v2 para obter mais informações.
      Nome Nome para identificar o registro do cliente do webhook.
    4. Clique em Enviar.

    Fornecer chave de autorização no Jenkins

    Receba atualizações do Jenkins fornecendo a chave de autorização no Jenkins.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Faça login na sua conta do Jenkins.
    2. Clique e abra o trabalho para o qual você deseja configurar o webhook.
    3. Clique em Configurar.
    4. Na guia Vinculações, clique em Adicionar e selecione Jenkins.

      Para obter mais informações sobre como usar o plug-in, consulte Vinculação de credenciais.

      Provedor de credenciais do Jenkins
    5. No formulário, preencha os campos.
      Tabela 2. Formulário de provedor de credenciais do Jenkins
      Campo Descrição
      Tipo Selecione Texto secreto.
      Segredo Insira a chave de autorização. Consulte Criar chave de autorização para o Spoke do Jenkins v2 para obter mais informações.
      ID Forneça um identificador exclusivo para identificar o registro.
    6. Clique em Adicionar.
    7. Na guia Ações de pós-criação, configure a tarefa e especifique o script para receber atualizações na sua instância ServiceNow.
      • Windows Scriptde exemplo: curl "https://<instance-name> .service-now.com/api/sn_jenkinsv2_spoke/jenkins_v2_webhook/build_status" -X POST -H "content-type:application/json" -H "jenkinsKey: %<ID> %" -d "{\_Job_Name\\:\%job_name%\\\, \\Job_Path\\:\%job_url%\\, \\Build_Number\\:\%BUILD_NUMBER%\}"
      • Shell Scriptde exemplo: curl "https://<instance-name> .service-now.com/api/sn_jenkinsv2_spoke/jenkins_v2_webhook/build_status" -X POST -H "content-type:application/json" -H "jenkinsKey: ${<ID> }" -d "{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\v }"
      Nota:
      O ID no script é o ID que você forneceu no formulário do provedor de credenciais do Jenkins.
      Para obter mais informações sobre como usar o plug-in, consulte Publicar tarefa de compilação.
    8. Clique em Aplicar.

    Fornecer descrição para o subfluxo

    Forneça descrições amigáveis para os subfluxos no Spoke do Jenkins v2.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Jenkins v2 > Subfluxos de resposta do Webhook.
    2. Clique em Nova.
    3. No formulário, preencha estes valores:
      Campo Descrição
      Descrição Descrição do subfluxo.
      Subfluxo Subfluxo necessário no Spoke do Jenkins v2.
    4. Clique em Enviar.

    Forneça respostas para a tabela de decisão

    Forneça subfluxos como respostas para as condições mencionadas na tabela de decisão. Quando as condições especificadas são atendidas, o subfluxo associado é acionado.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Definição do Sistema > Tabelas de Decisão.
    2. Abra o registro do spoke do Jenkins v2.
    3. Na guia Decisões, clique em Novo.
    4. No formulário, preencha estes valores:
      Tabela 3. 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.
      Condição Condições a serem atendidas quando os eventos necessários ocorrerem no Jenkins. Consulte Jenkins v2 Spoke para obter informações sobre os campos compatíveis.
      Resposta Subfluxo que deve ser acionado quando as condições especificadas forem atendidas.
      1. Clique no ícone de pesquisa ( ícone de pesquisa).
      2. Selecione o subfluxo necessário na lista Documento.
        Nota:
        Certifique-se de que o nome da tabela seja Subfluxo de resposta do webhook do Jenkins v2 [sn_jenkinsv2_spoke_webhook_answer_subflow].
    5. Clique em Enviar.

    Personalizar um webhook

    Crie uma política de roteamento de webhook e personalize o subfluxo de acordo com seus requisitos.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Flow Designer > Designer.
    2. Clique em Subfluxos.
    3. Crie uma cópia do subfluxo padrão necessário.
    4. Personalize o subfluxo de resposta do Webhook do Jenkins: processe o subfluxo de informações de compilação de acordo com seu requisito e publique-o.
      Consulte Criação de subfluxos para obter mais informações sobre como criar e usar subfluxos e Jenkins v2 Spoke para obter informações sobre os campos compatíveis com as políticas de roteamento e os subfluxos.
    5. Navegar até Jenkins v2 > Subfluxos de resposta do WebHook.
    6. Clique em Nova.
    7. No formulário, preencha os campos.
      Campo Descrição
      Descrição Descrição do subfluxo.
      Subfluxo Subfluxo necessário no Spoke do Jenkins v2.
    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 nessas tabelas.
    9. Navegar até Definição do Sistema > Tabelas de Decisão.
    10. Abra o registro do spoke do Jenkins v2.
    11. Na guia Decisões, clique em Novo.
    12. No formulário, preencha os seguintes campos:
      Tabela 4. 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.
      Condição Condições a serem atendidas quando os eventos necessários ocorrerem no Jenkins. Consulte Jenkins v2 Spoke para obter informações sobre os campos compatíveis.
      Resposta Subfluxo que deve ser acionado quando as condições especificadas forem atendidas.
      1. Clique no ícone de pesquisa ( ícone de pesquisa).
      2. Selecione o subfluxo necessário na lista Documento.
        Nota:
        Certifique-se de que o nome da tabela seja Subfluxo de resposta do webhook do Jenkins v2 [sn_jenkinsv2_spoke_webhook_answer_subflow].
    13. Clique em Enviar.