Voltar ao site
Webhook endpoints

Listar entregas do webhook endpoint

GET/v1/webhook-endpoints/{id}/deliveries

Uma linha por entrega (dlv_); attempt conta as tentativas feitas, e at, httpStatus, latencyMs e error são da última. FAILED = esgotou as 8 tentativas ou falhou o TEST; CANCELED = endpoint desativado/excluído ou cliente dono sem entitlement. Retenção de 30 dias.

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.

Authorization

kodanoOAuth webhooks:endpoints:read
headerAuthorizationBearer <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

Path Parameters

id*string

Id do webhook endpoint (whe_…).

Query Parameters

status?string

Status da entrega.

Value in"PENDING""RETRYING""SUCCEEDED""FAILED""CANCELED"
eventId?string

Entregas de um evento.

Match^evt_
limit?integer

Tamanho da página, 1–100; fora → 422 VALIDATION.FAILED.

Range1 <= value <= 100
Default20
cursor?string

nextCursor 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.

Header Parameters

X-Merchant-Id?string

Opcional. 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.

Match^mrc_[0-9a-f]{32}$
X-Correlation-Id?string

Opcional, sempre ecoado na resposta e repetido em correlationId do Problem. Ausente ou inválido → o serviço gera UUID v7.

Match^[A-Za-z0-9._-]{1,64}$

Response Body

Página de entregas.

application/json
  1. response
data*array<>
hasMore*boolean

Há página seguinte.

nextCursor*|

Cursor opaco e assinado da página seguinte; null quando hasMore é false.

Example Request
curl -X GET 'https://api.sandbox.kodano.com.br/v1/webhook-endpoints/string/deliveries' \  -H 'X-Merchant-Id: mrc_e3cc4727054da558273162251e310d29' \  -H 'X-Correlation-Id: erp-7f3a-0010'
Example Response
{  "data": [    {      "id": "dlv_ZrkZZHHC1NoGGox6w0q4q7qbATrRtvOO",      "eventId": "evt_M2yotFuA2lvn2cxfaDitt0GDJbOlKMAj",      "eventType": "payment.failed",      "kind": "EVENT",      "status": "RETRYING",      "attempt": 2,      "httpStatus": 503,      "latencyMs": 412,      "at": "2026-10-16T13:16:05Z",      "nextAttemptAt": "2026-10-16T13:21:05Z",      "error": "HTTP_5XX"    },    {      "id": "dlv_TJHo7OZTJLzpjeUuP14rbelsntNNVz9Y",      "eventId": "evt_3p9AGoWE8UWuBC7IXAOVmKwQSr82BLkj",      "eventType": "ping",      "kind": "TEST",      "status": "SUCCEEDED",      "attempt": 1,      "httpStatus": 200,      "latencyMs": 184,      "at": "2026-10-16T14:12:03Z",      "nextAttemptAt": null,      "error": null    }  ],  "hasMore": false,  "nextCursor": null}