Consultar a saúde dos webhooks

GET/v1/webhooks/health

O estado de entrega de cada webhook, somado entre os números: healthy, degraded (falhando: os eventos esperam na fila e são reenviados com espera crescente) ou suspended (parou em algum número: a fila foi descartada). Um webhook que nenhum número ativo cobre não aparece.

Requer#

Escopo da chave: Gerenciar webhooks managementComo os escopos funcionam
Recurso do plano: API e webhooks apiVer os planos que incluem
Formato: Próprio do Synergy. Erros em { "error": "…" }.

Parâmetros#

Cabeçalhos#

Cabeçalhos
Nome	Tipo	Obrigatório	Descrição
Authorization	string	obrigatório	Sua chave de API, no formato `Bearer <chave>`. Veja Autenticação.

Respostas#

Respostas
Status	Código	Quando acontece
200	—	Um webhook falhando
401	—	Chave revogada ou desconhecida
401	190	Chave malformada ou forjada
403	—	A chave não tem o escopo `management`
403	—	O plano da organização não inclui a API
429	—	Limite de taxa

Os erros no formato da Meta trazem o código em error.code. Ver todos os erros.

Corpo da resposta 200#

Campos da resposta 200
Nome	Tipo	Obrigatório	Descrição
data	object	obrigatório

Limites de taxa#

Gestão: 30 requisições a cada 60 s por chave (API_MGMT_LIMIT).

Notas#

A consulta pergunta a todos os números ativos da organização; um número que não responde fica fora da soma, sem erro.

Requisição

curl

curl 'https://api.synergyconnect.com.br/v1/webhooks/health' \
  -H "Authorization: Bearer $SYNERGY_API_KEY"

JavaScript

const res = await fetch('https://api.synergyconnect.com.br/v1/webhooks/health', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SYNERGY_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os

import requests

res = requests.get(
    "https://api.synergyconnect.com.br/v1/webhooks/health",
    headers={
        "Authorization": f"Bearer {os.environ['SYNERGY_API_KEY']}",
    },
)
print(res.status_code, res.json())

Resposta

200

{
  "data": {
    "7c1f0c7e-4b53-4c7b-9a51-3f6f0a2d9e10": {
      "state": "degraded",
      "pending": 12,
      "lastError": "HTTP 500",
      "lastFailureAt": 1767225600000,
      "dropped": 0,
      "droppedAt": null,
      "nextAt": 1767225630000
    }
  }
}

401

{
  "error": "Invalid or revoked key"
}

Há 2 casos com este status; veja a tabela de respostas.

403

{
  "error": "This key lacks the management scope"
}

Há 2 casos com este status; veja a tabela de respostas.

429

{
  "error": "Rate limit hit"
}

Ficou com dúvida? Escreva para suporte@synergyconnect.com.br.