Conecte o Semaphore às suas ferramentas

Use webhook quando um evento externo deva selecionar modelo predefinido e mapear valores para entradas aceitas. Use REST API para um fluxo mais explícito de recursos e execução, como iniciar tarefa e ler status. Em ambos, a automação usa o modelo de execução configurado do Semaphore. Escolha pelo que o chamador precisa enviar e acompanhar.

Um alias de projeto avalia os critérios de correspondência configurados nas suas integrações e pode iniciar aquelas que correspondem à solicitação. Um alias específico de integração direciona a solicitação a uma única integração, sem avaliar seus critérios. Essa diferença importa quando você espera que uma regra de branch ou tipo de evento controle a execução. Escolha o endpoint deliberadamente e teste payloads correspondentes e não correspondentes, em vez de presumir que o mesmo filtro se aplica a todos os caminhos de alias.

Configure extratores para ler cabeçalhos ou campos do corpo relevantes e mapeá-los para valores de ambiente ou parâmetros documentados da tarefa. Os destinos de parâmetros devem corresponder às entradas aceitas pelo modelo. Mantenha o mapeamento específico: uma versão de release deve se tornar a entrada pretendida, não um fragmento irrestrito de comando. Valide o valor na automação quando seu significado exigir e teste campos ausentes ou inesperados antes do uso em produção.

Um token de API atua com as permissões do seu usuário Semaphore. Use uma identidade cujo acesso ao projeto corresponda às operações pretendidas pela integração e proteja o token onde o chamador o armazena. A API não contorna a autorização do projeto. Para integrações por webhook, configure deliberadamente também a autenticação documentada da solicitação e a exposição do endpoint. Separe a autenticação do chamador das credenciais que a tarefa resultante usa para acessar a infraestrutura.

Em um fluxo REST API, retenha o identificador de tarefa retornado pela operação documentada e use os métodos correspondentes para inspecionar estado e saída. Uma solicitação bem-sucedida significa que a execução foi solicitada, não que o trabalho de infraestrutura terminou com sucesso. Seu serviço deve distinguir erros de solicitação, tarefas aguardando ou em execução e resultados concluídos. Encaminhe engenheiros à tarefa quando precisarem investigar as evidências reais de execução.

Não presuma execução exatamente uma vez nem garantias de entrega durável. Um serviço externo pode repetir uma solicitação após tempo limite mesmo quando a primeira chegou ao Semaphore. Projete o tratamento de duplicidades e as decisões de nova tentativa conforme as consequências da operação e torne a automação subjacente idempotente quando adequado. Mantenha uma correlação entre o evento de origem e a execução acompanhada pelo serviço para que engenheiros entendam entregas repetidas ou incertas.

A referência deste site renderiza o documento Swagger/OpenAPI publicado com a versão Semaphore. Operações, caminhos e esquemas correspondem a uma versão específica, não a um resumo manual. Consulte por recurso em /api-docs/ ou leia o documento original para gerar um cliente. Sempre confira a especificação da versão realmente usada, pois endpoints e esquemas podem mudar entre versões.

O sistema chamador precisa alcançar sua instância Semaphore, mas isso não exige internet pública. Rede privada, VPN ou balanceador interno bastam quando o chamador está dentro. Nossa verificação de critérios e extratores usou listener só de loopback sem autenticação, não um exemplo para endpoint exposto. Sempre que o alias puder ser acessado fora da rede confiável, configure autenticação compatível e restrinja também a exposição na rede.

Primeiro direcione a integração a um modelo inofensivo e envie os payloads com curl ou outro cliente HTTP. Envie um corpo sem correspondência e confirme que nenhuma tarefa aparece; depois envie um correspondente e confirme o início de exatamente uma tarefa. Abra os Detalhes: a integração fica registrada como origem e os valores extraídos aparecem para a execução. É a sequência que usamos localmente e detecta uma chave incorreta no critério antes de um serviço externo depender dele.

Sim. A REST API abrange projetos, repositórios, inventários, credenciais, grupos de variáveis, modelos e outros recursos. Seu portal ou serviço de infraestrutura pode configurar, iniciar tarefas e ler status e saída. Pro também expõe execuções e aprovações de workflows pela API para um pipeline CI/CD iniciar uma operação completa. Use a referência OpenAPI para parâmetros e esquemas de resposta.