Skip to main content

GET Listar Endpoints de Webhook

Lista os endpoints de webhook da conta, do mais antigo para o mais novo, com as estatísticas de entrega das últimas 24 horas. Não inclui o segredo de assinatura.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão manage_webhooks.


Endpoint​

GET https://api-dev.imagemais.com.br/api/webhooks/endpoints

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/webhooks/endpoints' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

[
{
"id": 3,
"url": "https://consumidor.exemplo/webhooks/pepia/clinica-x",
"description": "Integração com o sistema da clínica",
"event_types": [
"appointment.queued",
"appointment.canceled"
],
"filters": {
"procedure_types": [
"IMAGEM"
]
},
"enabled": true,
"disabled_reason": null,
"disabled_at": null,
"failing_since": null,
"created_by": {
"type": "user",
"id": 345,
"name": "Nome Exemplo"
},
"created_at": "2026-10-06T14:32:10.123Z",
"updated_at": "2026-10-06T14:32:10.123Z",
"stats_24h": {
"total": 42,
"succeeded": 40,
"failed": 1,
"pending": 1,
"avg_latency_ms": 180,
"last_attempt_at": "2026-10-06T17:10:00.000Z"
}
}
]

stats_24h.avg_latency_ms é a média só das entregas bem-sucedidas (null se não houve nenhuma). Os valores disabled_reason possíveis são GONE (o consumidor respondeu 410), FAILING (2 dias sem entrega bem-sucedida) e MANUAL (desativado por enabled: false).

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}