Listar os webhooks

GET/v1/webhooks

Os webhooks da organização que a chave alcança, do mais novo para o mais antigo. Uma chave limitada a alguns números só vê os webhooks restritos a esses números. O secret e os valores dos headers nunca aparecem.

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
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
data[].id	string	obrigatório
data[].url	string	obrigatório
data[].fields	string[]	obrigatório
data[].statuses	string[] \| null	obrigatório
data[].instanceIds	string[] \| null	obrigatório
data[].enabled	boolean	obrigatório
data[].verification	string	obrigatório	Valores: `meta`, `ping`.
data[].headerNames	string[] \| null	obrigatório	Os NOMES dos headers próprios; os valores nunca voltam.
data[].disabledReason	string \| null	obrigatório
data[].createdBy	string	obrigatório	O id do usuário que criou, ou `key:<id da chave>` quando foi pela API.
data[].createdAt	integer	obrigatório	Quando foi criado (ms desde 1970).
data[].updatedAt	integer	obrigatório	A versão do webhook: toda alteração muda, e recomeça a saúde dele em cada número (ms desde 1970).
data[].name	string \| null	obrigatório	Um rótulo seu (o node do n8n usa `n8n · <workflow> · prod\|test`). Opcional.

Limites de taxa#

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

Requisição

curl

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

JavaScript

const res = await fetch('https://api.synergyconnect.com.br/v1/webhooks', {
  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",
    headers={
        "Authorization": f"Bearer {os.environ['SYNERGY_API_KEY']}",
    },
)
print(res.status_code, res.json())

Resposta

200

{
  "data": [
    {
      "id": "7c1f0c7e-4b53-4c7b-9a51-3f6f0a2d9e10",
      "url": "https://hooks.example.com/synergy",
      "fields": [
        "messages",
        "statuses"
      ],
      "statuses": null,
      "instanceIds": null,
      "enabled": true,
      "verification": "ping",
      "headerNames": [
        "Authorization"
      ],
      "disabledReason": null,
      "createdBy": "key:0b9c4d1e-52a7-4f6b-8c3d-1e2f3a4b5c6d",
      "createdAt": 1767225600000,
      "updatedAt": 1767225600000,
      "name": null
    }
  ]
}

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.