Configure um webhook para o spoke do Jenkins

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 4 min. de leitura
  • Configure uma aplicação webhook para receber as atualizações necessárias do Jenkins em seu ServiceNowinstância.

    Antes de Iniciar

    Função necessária: administrador

    Criar chave de autorização para 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é Tudo > Definição do Sistema > Scripts - Segundo Plano.
    2. Insira este comando no Script de execução (javascript executado no servidor) campo de texto:
      gs.info(GlideSecureRandomUtil.getSecureRandomString(32));
    3. Clique em Script de execução .
    4. Copie e registre o valor gerado para uso posterior.
      Chave de autorização ou segredo do cliente

    Forneça a chave de autorização para o webhook

    Autorize solicitações do Jenkins fornecendo a chave de autorização para webhook em seu ServiceNowinstância.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

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

    Forneça a 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 em e abra o trabalho para o qual você deseja configurar seu webhook.
    3. Clique em Configurar.
    4. Em 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 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 Spoke do Jenkins v2para obter mais informações.
      ID Forneça um identificador exclusivo para identificar o registro.
    6. Clique em Adicionar.
    7. Em Ações pós-compilação configure a tarefa e especifique o script para receber atualizações no ServiceNowinstância.
      • Amostra Windows Script : "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
      • Shell de amostra Script : "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_NAME", "JOB_path":" "JOB_URL", "build_number":"
      Nota:
      O ID no script é o ID que você forneceu no formulário Provedor de credenciais do Jenkins.
      Para obter mais informações sobre como usar o plug-in, consulte Tarefa de pós-compilação .
    8. Clique em “Aplicar”.

    Forneça uma descrição para o subfluxo

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

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Tudo > 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 sobre o 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é Tudo > Definição do Sistema > Tabelas de Decisão.
    2. Abra o registro do Spoke do Jenkins v2 .
    3. Em 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 obrigatórios ocorrem no Jenkins. Consulte Spoke do Jenkins v2para obter informações sobre os campos compatíveis.
      Resposta Subfluxo que deve ser acionado quando as condições especificadas são atendidas.
      1. Clique no ícone Pesquisa ( Ícone de pesquisa).
      2. Selecione o subfluxo necessário na lista Documentos.
        Nota:
        Certifique-se de que Nome da tabela é Subfluxo de resposta do webhook do Jenkins v2 [sn_jenkinsv2_spoke_webhook_answer_subflow] .
    5. Clique em Enviar.

    Personalize um webhook

    Crie uma política de roteamento de webhook e personalize o subfluxo de acordo com sua necessidade.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Tudo > 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 Jenkins webhook: Processe o subfluxo de informações de compilação de acordo com sua necessidade e publique-o.
      Consulte Criando subfluxos para obter mais informações sobre como criar e usar subfluxos e. Spoke do Jenkins v2para obter informações sobre os campos compatíveis com as políticas de roteamento e 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 sobre o 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 advertidos contra atualizar ou modificar diretamente os dados nessas tabelas.
    9. Navegar até Definição do Sistema > Tabelas de Decisão.
    10. Abra o registro do Jenkins v2 spoke.
    11. Em 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 obrigatórios ocorrem no Jenkins. Consulte Spoke do Jenkins v2para obter informações sobre os campos compatíveis.
      Resposta Subfluxo que deve ser acionado quando as condições especificadas são atendidas.
      1. Clique no ícone Pesquisa ( Ícone de pesquisa).
      2. Selecione o subfluxo necessário na lista Documentos.
        Nota:
        Certifique-se de que Nome da tabela é Subfluxo de resposta do webhook do Jenkins v2 [sn_jenkinsv2_spoke_webhook_answer_subflow] .
    13. Clique em Enviar.