Listar entregas

Este endpoint retorna uma lista paginada das tentativas de entrega (dispatches) de eventos de webhook da sua conta, com filtros por status, endpoint, código HTTP de resposta e intervalo de datas. É a

Visão Geral

Este endpoint retorna uma lista paginada das tentativas de entrega (dispatches) de eventos de webhook da sua conta, com filtros por status, endpoint, código HTTP de resposta e intervalo de datas. É a ferramenta principal para auditar entregas e diagnosticar falhas por endpoint.

Descrição

Cada item representa uma entrega de um evento a um endpoint específico, com o resultado da tentativa (status, responseStatusCode, responseTime) e os carimbos de tempo relevantes.

Requisição

GET /v1/webhooks/dispatches

Cabeçalho: SelectKey: sk_live_... (ou sk_test_...). Escopo necessário: webhooks:read.

Parâmetros de Consulta

Parâmetro	Tipo	Descrição	Exemplo
`offset`	integer	Ponto de início dos resultados (padrão `0`)	`0`
`limit`	integer	Máximo de registros (padrão `20`, máximo `100`)	`20`
`sort`	string	Expressão de ordenação (aceita `ascending`/`descending`)	`descending`
`status`	string	Filtra pelo resultado: `pending`, `success`, `failed`, `retrying`, `canceled`	`success`
`responseStatus`	integer	Filtra pelo código HTTP retornado pelo seu servidor	`200`
`onlyErrored`	boolean	Se `true`, retorna apenas entregas com falha	`false`
`endpoint`	string	Filtra pela URL exata do endpoint de destino	`https://webhooks.mydomain.com/selectwin`
`daterange`	string (date)	Filtra por um único dia de criação	`2026-06-20`
`daterangegt` / `daterangegte`	string (date-time)	Criado após / a partir de	`2026-06-01T00:00:00Z`
`daterangelt` / `daterangelte`	string (date-time)	Criado antes de / até	`2026-06-30T23:59:59Z`

Os aliases legados responsestatus e onlyerrored (minúsculos) também são aceitos.

Resposta

Sucesso (200 OK)

Envelope paginado padrão (com merchant/_links no root); cada item de data é um dispatch.

{
  "offset": 0,
  "limit": 20,
  "total": 50,
  "page": {
    "offset": { "first": 0, "prev": 0, "next": 20, "last": 40 },
    "current": 1,
    "total": 3
  },
  "hasMore": true,
  "data": [
    {
      "id": "wdi_01hqzvabc",
      "eventId": "wbh_01hqzvabc",
      "endpointId": "wbe_01hqzvabc",
      "endpoint": "https://webhooks.mydomain.com/selectwin",
      "status": "success",
      "attempts": 1,
      "responseStatusCode": 200,
      "responseTime": 120,
      "nextAttemptAt": null,
      "lastAttemptAt": "2026-06-20T17:56:33.000Z",
      "successAt": "2026-06-20T17:56:33.050Z",
      "createdAt": "2026-06-20T17:56:33.000Z"
    }
  ],
  "merchant": {
    "name": "Seller Name",
    "merchantId": "bus_1234567890",
    "isSubAccount": false
  },
  "_links": {
    "self": {
      "href": "https://api.selectwin.io/v1/webhooks/dispatches",
      "method": "GET",
      "description": "List all webhook dispatches."
    }
  }
}

Atributos do Envelope

Atributo	Tipo	Descrição
`offset` / `limit` / `total` / `page` / `hasMore`		Paginação padrão
`data`	array	Dispatches (ver abaixo)
`merchant`	object	Bloco do lojista
`_links`	object	HATEOAS (`self`)

Atributos do Dispatch (item de data)

Atributo	Tipo	Descrição
`id`	string	Identificador do dispatch (`wdi_`)
`eventId`	string \| null	ID do evento associado (`wbh_`)
`endpointId`	string \| null	ID do endpoint de destino (`wbe_`)
`endpoint`	string	URL do endpoint de destino
`status`	string	`pending`, `success`, `failed`, `retrying` ou `canceled`
`attempts`	integer	Número de tentativas realizadas
`responseStatusCode`	integer \| null	Código HTTP retornado pelo seu servidor
`responseTime`	integer \| null	Tempo de resposta em milissegundos
`nextAttemptAt`	string (ISO) \| null	Próxima tentativa agendada (quando `retrying`)
`lastAttemptAt`	string (ISO) \| null	Data da última tentativa
`successAt`	string (ISO) \| null	Data em que a entrega foi confirmada
`createdAt`	string (ISO)	Data de criação do dispatch

Exemplo de Uso

Consulta Básica

GET /v1/webhooks/dispatches

Apenas Entregas com Falha

GET /v1/webhooks/dispatches?onlyErrored=true

Filtrar por Status e Endpoint

GET /v1/webhooks/dispatches?status=failed&endpoint=https://webhooks.mydomain.com/selectwin

Filtrar por Período

GET /v1/webhooks/dispatches?daterangegte=2026-06-01T00:00:00Z&daterangelte=2026-06-30T23:59:59Z

Códigos de Erro

Código HTTP	Descrição
401	Não autorizado (`SelectKey` ausente/inválida)
403	Sem o escopo `webhooks:read`
500	Erro interno do servidor

Listar entregas

On this page