Payload do webhook genérico

Requisição

POST https://ingress.aciona.me/webhooks/<idDaFonte>
Content-Type: application/json
X-Aciona-Token: <tokenDaFonte>

O corpo é um objeto JSON representando um único alerta.

Campos

string

Título do acionamento. Quando ausente, o aciona.me usa Untitled alert.

string

Detalhe do problema. Aparece no corpo do acionamento e nas notificações.

string

padrão:"warning"

Severidade do alerta. Aceita os valores canônicos critical, high, warning e info, além de sinônimos comuns (p1, sev2, error, warn, low…). Valores não reconhecidos caem em warning.

string

Nome do serviço afetado, como cadastrado no aciona.me. Também aceito em labels.service. Determina o time responsável e, por consequência, quem é acionado.

string

Identificador estável do problema na origem. É a chave de correlação usada para agregar disparos repetidos no mesmo acionamento e para casar a recuperação com o acionamento aberto. Obrigatório quando status é resolved: precisa ser texto não vazio (não só espaços) ou número; caso contrário, a requisição é recusada com 400. É comparado exatamente como enviado.

string

padrão:"firing"

firing ou alerting abrem ou agregam; resolved resolve o acionamento aberto por esta fonte com o mesmo externalId. A comparação ignora maiúsculas/minúsculas. Qualquer outro valor (inclusive ok, normal, recovered, closed) faz o alerta ser aceito e descartado, sem criar nem resolver acionamento. Quando ausente, é tratado como firing.

object

Rótulos livres, preservados no acionamento. Útil para contexto (env, region, cluster, job).

string

Link de volta para a origem do alerta. Também aceito como externalUrl.

Exemplo completo

{
  "externalId": "checkout-error-rate",
  "title": "Taxa de erro no checkout acima de 5%",
  "description": "Erros 5xx em 7,2% das requisições nos últimos 5 minutos",
  "severity": "critical",
  "service": "checkout",
  "status": "firing",
  "labels": {
    "env": "prod",
    "region": "sa-east-1",
    "cluster": "prod-a"
  },
  "url": "https://observabilidade.exemplo.com/d/checkout"
}

Exemplo mínimo

{
  "title": "Job noturno falhou",
  "service": "pipeline-dados"
}

Exemplo de recuperação

{
  "status": "resolved",
  "externalId": "checkout-error-rate"
}

Resolve o acionamento aberto por esta fonte com o mesmo externalId, em qualquer estado ativo — inclusive reconhecido ou assumido —, e o encerra automaticamente 5 minutos depois. Título e descrição podem ser incluídos e não são usados na correlação. Detalhes em Recuperação automática.

Resposta

{ "accepted": true, "alertIds": ["<uuid>"] }

Com HTTP 202. O processamento é assíncrono: o acionamento aparece (ou é resolvido) no painel em segundos. Quando o status é ignorado, alertIds vem vazio. O 202 confirma o aceite, não que um acionamento foi criado ou resolvido.

Limitações

Um POST representa um alerta. Para vários alertas, faça vários POSTs.
O corpo tem limite de tamanho (por padrão, 1 MB).
A recuperação só resolve acionamentos abertos pela mesma fonte; não usa título, serviço nem a assinatura do conteúdo.
Reutilizar a mesma chave entre quedas permite que uma recuperação atrasada resolva a ocorrência seguinte. Se isso importa, use uma chave por episódio.
Em rajadas, uma recuperação pode ser processada antes da abertura e, nesse caso, não resolve nada.

Referência

Payload do webhook genérico

Requisição

Campos

Exemplo completo

Exemplo mínimo

Exemplo de recuperação

Resposta

Limitações

Guia do webhook genérico

​Requisição

​Campos

​Exemplo completo

​Exemplo mínimo

​Exemplo de recuperação

​Resposta

​Limitações

Guia do webhook genérico

Requisição

Campos

Exemplo completo

Exemplo mínimo

Exemplo de recuperação

Resposta

Limitações