Operação do Pipeline: Webhook

Configure etapas do pipeline para chamar sistemas externos ou APIs via Webhooks, permitindo integrações automatizadas, notificações e fluxos de trabalho personalizados como parte do seu processo DevOps.

O Webhook a operação de pipeline permite que o Revvy chame sistemas externos ou APIs como parte de um processo DevOps automatizado. Isso é útil para acionar fluxos de trabalho downstream, notificar serviços externos ou integrar com ferramentas de automação personalizadas.

Opções de Configuração

Ao adicionar uma operação Webhook em um passo do pipeline, você configurará os seguintes campos:

  • Nome – Rótulo para o passo no pipeline.

  • Operação – Selecionar Webhook.

  • URL – A URL do endpoint que o Revvy deve chamar.

  • Autenticação – Opções:

    • Basic – Forneça nome de usuário e senha.

    • OAuth – Use um token de acesso para autenticação.

  • Método – Métodos HTTP suportados: GET ou POST.

  • Cabeçalhos adicionais – Cabeçalhos personalizados opcionais (por exemplo, Content-Type: application/json).

  • Nome de usuário / Senha – Obrigatório se a Autenticação Basic for selecionada.

  • Origem do Token / Token de Acesso – Obrigatório se OAuth for selecionado.

  • Payload – (apenas POST) Corpo JSON ou form a ser enviado com a requisição.

  • Próximo passo (Em sucesso / Em falha) – Defina como o pipeline continua com base na resposta.

Executando um Pipeline

  1. Navegue até Pipelines pela navegação à esquerda.

  2. Selecione o pipeline que contém seu passo Webhook.

  3. Clique Executar pipeline.

  4. Escolha o branch e confirme a execução.

  5. O pipeline será executado passo a passo — se o passo Webhook for alcançado, um trabalho Webhook será criado em Atividades.

Visualizando Resultados

  • Vá para a Atividades aba do seu branch.

  • Em Jobs, encontre o trabalho Webhook. O status mostra:

    • Concluído – Webhook respondeu com 200 OK.

    • Exceção – Ocorreu um erro (verifique os logs).

  • Clique Ver Logs (ou abra a execução do pipeline) para revisar detalhes da requisição/resposta, carimbos de data/hora e duração da execução.

  • Para pipelines, expanda a visualização do fluxo do Pipeline para ver cada passo (Passo Manual, Webhook, Deploy, etc.) com status individuais.

Execução do Job e Status

  • Um job é criado quando o pipeline atinge o passo Webhook.

  • O status do job mostrará Concluído se o Webhook responder com 200 OK.

  • Se o Webhook falhar (timeouts, erros 4xx/5xx), o job será marcado como Exceção ou siga a Rota em falha .

Exemplos

Exemplo 1: GET com Autenticação Basic

Use Basic Auth para uma chamada simples de API GET.

  • URL: https://httpbin.org/get

  • Método: GET

  • Autenticação: Basic

  • Nome de usuário: testuser

  • Senha: testpassword

  • Cabeçalhos: deixe em branco

  • Próximo passo (Em sucesso): Continuar pipeline

  • Próximo passo (Em falha): Parar

Resultado: o httpbin retorna 200 OK e ecoa as credenciais Basic Auth.

Exemplo 2: POST com Autenticação Basic

Envie dados de forma segura com credenciais e um payload.

  • URL: https://httpbin.org/post

  • Método: POST

  • Autenticação: Basic

  • Nome de usuário: testuser

  • Senha: testpassword

  • Cabeçalhos: Content-Type: application/json

  • Payload:

  • Próximo passo (Em sucesso): Continuar pipeline

  • Próximo passo (Em falha): Parar

Resultado: o httpbin ecoa o payload JSON e retorna 200 OK.

Exemplo 3: GET com Token de Acesso OAuth

Use um token bearer para requisições GET seguras.

  • URL: https://httpbin.org/get

  • Método: GET

  • Autenticação: OAuth

  • Origem do Token: Token de Acesso

  • Token de Acesso: seu-token-de-teste

  • Cabeçalhos: deixe em branco

  • Próximo passo (Em sucesso): Continuar pipeline

  • Próximo passo (Em falha): Parar

Resultado: o cabeçalho Authorization é passado, o httpbin responde 200 OK com detalhes do token.

Exemplo 4: POST com Token de Acesso OAuth

Envie payloads JSON com tokens OAuth.

  • URL: https://httpbin.org/post

  • Método: POST

  • Autenticação: OAuth

  • Origem do Token: Token de Acesso

  • Token de Acesso: seu-token-de-teste

  • Cabeçalhos: Content-Type: application/json

  • Payload:

  • Próximo passo (Em sucesso): Continuar pipeline

  • Próximo passo (Em falha): Parar

Resultado: o httpbin confirma que o token + payload foram recebidos e retorna 200 OK.

Melhor Prática

  • Use POST + Basic para serviços internos com credenciais simples.

  • Use OAuth (GET ou POST) para APIs modernas que exigem tokens bearer.

  • Sempre teste pipelines primeiro com httpbin.org ou webhook.site para confirmar a configuração antes de conectar a APIs de produção.

  • Configure Rota em falha roteamento para tratar erros de API de forma graciosa (por exemplo, parar o pipeline, enviar rollback ou notificar a equipe).

Atualizado