Listar webhook endpoints
/v1/webhook-endpointsEscopo ORGANIZATION lista os endpoints da organização e de todos os merchants do tenant; escopo MERCHANT lista só os do merchant. Excluídos e o secret nunca aparecem; só o ambiente do host.
X-Merchant-Id é opcional: credencial de organização sem o header atua no escopo ORGANIZATION (organização e todos os merchants do tenant); com o header, no escopo MERCHANT daquele merchant. Credencial de merchant atua sempre no próprio merchant.
kodanoOAuth webhooks:endpoints:readAuthorizationBearer <token>Token obtido no Zitadel do ambiente (POST /oauth/v2/token), fora do host da API, e enviado em Authorization: Bearer <access_token>.
- Sandbox:
https://kodano-uat-p55zt6.us1.zitadel.cloud/oauth/v2/token - Produção:
https://kodano-prod-qe8hbt.us1.zitadel.cloud/oauth/v2/token
Use sempre o tokenUrl devolvido na emissão da credencial. Duas variantes: private_key_jwt (preferida; grant urn:ietf:params:oauth:grant-type:jwt-bearer com assertion RS256 assinada pela chave da credencial, iss = sub = userId, aud = authority do Zitadel, kid = keyId) e client_secret (grant client_credentials). O OpenAPI só modela a segunda.
O parâmetro scope do token é OIDC, não os escopos da API: openid urn:zitadel:iam:org:project:id:<projectId da API>:aud urn:zitadel:iam:user:resourceowner. Sem o :aud a API responde 401 AUTH.TOKEN_INVALID; sem resourceowner, 403 AUTH.TENANT_MISMATCH.
Os 28 escopos abaixo são os entitlements concedidos à credencial pelos produtos de integração (produto:recurso:ação; write não implica read), avaliados a cada requisição; não são pedidos no token. O tenant vem da organização do token; o merchant, de X-Merchant-Id. Revogar a credencial nega os tokens já emitidos em até 60 s.
Scope: webhooks:endpoints:read
status?stringStatus do endpoint.
"ACTIVE""DISABLED"limit?integerTamanho da página, 1–100; fora → 422 VALIDATION.FAILED.
1 <= value <= 10020cursor?stringnextCursor da página anterior, com os mesmos filtros e o mesmo limit. Adulterado, de outra lista, de outro merchant ou com filtros diferentes → 422 CURSOR.INVALID.
X-Merchant-Id?stringOpcional. Credencial de organização sem o header atua no nível da organização; com o header, no merchant indicado. Fora do tenant, inexistente ou diferente do merchant da credencial de merchant → 403 MERCHANT.FORBIDDEN.
^mrc_[0-9a-f]{32}$X-Correlation-Id?stringOpcional, sempre ecoado na resposta e repetido em correlationId do Problem. Ausente ou inválido → o serviço gera UUID v7.
^[A-Za-z0-9._-]{1,64}$Página de endpoints.
application/json- response
data*array<>hasMore*booleanHá página seguinte.
nextCursor*|Cursor opaco e assinado da página seguinte; null quando hasMore é false.
curl -X GET 'https://api.sandbox.kodano.com.br/v1/webhook-endpoints' \ -H 'X-Merchant-Id: mrc_e3cc4727054da558273162251e310d29' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "data": [ { "id": "whe_izfjJZWGfTqJPVzq8t9rvtgg8t9kJStn", "url": "https://hooks.parceiro.com.br/kodano-org", "description": "Conciliação central", "events": [ "settlement.closed", "withdrawal.completed", "withdrawal.failed", "webhook_endpoint.disabled" ], "status": "ACTIVE", "scope": "ORGANIZATION", "merchantId": null, "failureCount": 0, "lastSuccessAt": "2026-10-16T13:20:04Z", "lastFailureAt": null, "disabledAt": null, "disabledReason": null, "previousSecretExpiresAt": null, "createdAt": "2026-10-16T12:50:00Z", "updatedAt": "2026-10-16T13:20:04Z" }, { "id": "whe_zQ7EUbzgd8SsjEVUqldLn3OYxujoQHxr", "url": "https://hooks.parceiro.com.br/kodano", "description": "ERP financeiro", "events": [ "payment.succeeded", "payment.failed", "payment.refunded" ], "status": "ACTIVE", "scope": "MERCHANT", "merchantId": "mrc_e3cc4727054da558273162251e310d29", "failureCount": 0, "lastSuccessAt": "2026-10-16T13:02:12Z", "lastFailureAt": null, "disabledAt": null, "disabledReason": null, "previousSecretExpiresAt": null, "createdAt": "2026-10-16T12:40:00Z", "updatedAt": "2026-10-16T13:02:12Z" } ], "hasMore": false, "nextCursor": null}