Webhooks

Cadastre destinos HTTPS, escolha os eventos, teste e acompanhe as entregas.

Um webhook envia um evento do Mira, como um report criado ou um comentário novo, para um endereço HTTPS que você controla.

Para validar a assinatura e conhecer o formato de cada evento, veja Payloads de webhook.

Cadastrar um destino

Quem faz: admin do projeto.

Abrir Webhooks

Em Configurações do projeto, abra Integrações e clique em Webhooks. O painel lateral lista os destinos.

Adicionar o destino

Clique em Adicionar destino e informe o nome, a URL HTTPS pública e os eventos que o destino recebe.

Guardar o segredo

Salve e copie o segredo (mira_whsec_...) para a configuração privada de quem recebe. Ele aparece uma vez e não pode ser consultado depois.

Testar

Use Enviar teste e abra o Histórico de entregas para ver o resultado.

Painel Webhooks com um destino e o histórico de entregas
Um destino cadastrado e o histórico de entregas.

A URL precisa usar HTTPS com certificado válido. O Mira recusa HTTP, endereços privados e URLs com usuário, senha ou fragmento, e não segue redirects. Não coloque segredos na URL.

Eventos

EventoQuando
report.createdNovo report confirmado
report.updatedCampos ou tags de um report mudaram
comment.createdComentário adicionado
attachment.createdLink ou arquivo adicionado
error.createdPrimeira ocorrência de um erro novo
error.regressedErro resolvido voltou numa release com build posterior
error.spikePico de ocorrências de um erro
digest.dailyTodo dia às 09:00, se o projeto tem reports parados
digest.weeklySegunda-feira, com o resumo semanal

Os eventos de erro e de digest só chegam a destinos que os marcam na configuração. No formulário, os digests aparecem como Digest diário e Resumo semanal.

Manter o destino

O painel permite rotacionar o segredo, pausar o destino e consultar as entregas, com o payload e as tentativas. O histórico é visível só para admins.

Quando uma entrega falha, o Mira tenta de novo até cinco vezes, com intervalos crescentes. Depois da última falha, Reenviar inicia outro ciclo. Pausar um destino cancela as entregas pendentes, e reativar não reproduz o que aconteceu durante a pausa.

Próximos passos

Nesta página