Skip to main content

GET Listar Entregas

Histórico das entregas do endpoint nos últimos 2 dias, da mais recente para a mais antiga, com paginação por cursor. Não inclui o corpo da resposta do consumidor.

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/{id}/deliveries

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idnumber✅ID do endpoint de webhook

Parâmetros de Query​

NomeTipoObrigatórioValores válidosDescrição
statusstring❌PENDING, SUCCEEDED, FAILEDFiltra pela situação da entrega
event_idstring❌até 64 caracteresEntregas de um evento específico (ex.: o devolvido pelo ping)
limitnumber❌inteiro de 1 a 100; padrão 20Itens por página
cursornumber❌inteiro positivoId da última entrega carregada (next_cursor da página anterior)

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/webhooks/endpoints/1/deliveries?status=FAILED&limit=20' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"data": [
{
"id": 128,
"event_id": "evt_01M4E8BB44BXNGF09XM1FAB8Z9",
"event_type": "webhook.ping",
"status": "SUCCEEDED",
"attempts": 1,
"last_status_code": 200,
"last_latency_ms": 143,
"last_error": null,
"last_attempt_at": "2026-10-06T14:32:11.000Z",
"created_at": "2026-10-06T14:32:10.500Z",
"payload": {
"id": "evt_01M4E8BB44BXNGF09XM1FAB8Z9",
"type": "webhook.ping",
"api_version": "2026-10-01",
"data": {}
}
}
],
"next_cursor": null
}

next_cursor vem preenchido quando a página veio cheia (limit itens); envie esse valor em cursor para a próxima página. null indica que acabou.

400 Requisição inválida​

Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:

{
"message": [
"status must be one of the following values: PENDING, SUCCEEDED, FAILED",
"limit must not be greater than 100"
],
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

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

404 Não encontrado​

{
"message": "Endpoint de webhook não encontrado",
"error": "Not Found",
"statusCode": 404
}