Listar endpoints

Este endpoint lista os webhook endpoints configurados na sua conta, com paginação e filtros por nome, URL do endpoint, status (ativo/inativo) e intervalo de datas.

Visão Geral

Este endpoint lista os webhook endpoints configurados na sua conta, com paginação e filtros por nome, URL do endpoint, status (ativo/inativo) e intervalo de datas.

Precauções

Use os filtros para limitar os resultados e encontrar endpoints específicos.
A resposta é paginada; utilize offset/limit para navegar entre os resultados.

Descrição

A listagem é útil para obter uma visão geral de todos os endpoints, verificar seu status (enabled) e gerenciar suas integrações.

Requisição

GET /v1/webhooks

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

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
`offset`	integer	Não	Posição inicial para paginação (padrão `0`)	`0`
`limit`	integer	Não	Máximo de registros por página (padrão `20`, máximo `100`)	`20`
`sort`	string	Não	Expressão de ordenação (aceita também `ascending`/`descending`)	`descending`
`name`	string	Não	Filtro por nome (substring)	`Webhook`
`endpoint`	string	Não	Filtro por URL exata do endpoint	`https://webhooks.mydomain.com/selectwin`
`status`	string	Não	Filtro por status: `active`/`enabled` ou `inactive`/`disabled`	`active`
`daterange`	string (date)	Não	Filtra por um único dia de criação	`2026-06-20`
`daterangegt` / `daterangegte`	string (date-time)	Não	Criado após / a partir de	`2026-06-01T00:00:00Z`
`daterangelt` / `daterangelte`	string (date-time)	Não	Criado antes de / até	`2026-06-30T23:59:59Z`

Exemplo de Requisição

GET /v1/webhooks?limit=5&offset=0&status=active&sort=descending

Resposta

Sucesso (200 OK)

{
  "offset": 0,
  "limit": 20,
  "total": 2,
  "page": {
    "offset": { "first": 0, "prev": 0, "next": 0, "last": 0 },
    "current": 1,
    "total": 1
  },
  "hasMore": false,
  "data": [
    {
      "id": "wbe_01hqzvabc",
      "name": "Webhook MyDomain",
      "endpoint": "https://webhooks.mydomain.com/selectwin",
      "enabled": true,
      "events": ["transaction.approved", "transaction.pending"],
      "forceActive": false,
      "shotsQty": 3068,
      "failedShotsQty": 12,
      "lastDeliveryAt": "2026-06-20T17:56:33.000Z",
      "metadata": { "team": "ops" },
      "createdAt": "2026-01-26T20:18:05.000Z",
      "updatedAt": "2026-06-20T17:56:33.000Z",
      "_links": {
        "self": { "href": "https://api.selectwin.io/v1/webhooks/wbe_01hqzvabc", "method": "GET", "description": "Read a webhook." }
      }
    }
  ],
  "merchant": {
    "name": "Seller Name",
    "merchantId": "bus_1234567890",
    "isSubAccount": false
  },
  "_links": {
    "self": {
      "href": "https://api.selectwin.io/v1/webhooks",
      "method": "GET",
      "description": "List all webhooks."
    }
  }
}

O secret nunca aparece na listagem nem na leitura; ele só é retornado no create e no rotate-secret.

Atributos da Resposta

Envelope da lista

Atributo	Tipo	Descrição
`offset`	integer	Posição inicial da consulta
`limit`	integer	Máximo de registros retornados
`total`	integer	Total de registros encontrados
`page`	object	Objeto de paginação rico (ver abaixo)
`hasMore`	boolean	Indica se há mais registros
`data`	array	Endpoints retornados
`merchant`	object	Bloco do lojista
`_links`	object	HATEOAS (`self`)

Objeto page

Atributo	Tipo	Descrição
`page.offset.first`	integer	Offset da primeira página
`page.offset.prev`	integer	Offset da página anterior
`page.offset.next`	integer	Offset da próxima página
`page.offset.last`	integer	Offset da última página
`page.current`	integer	Número da página atual (1-based)
`page.total`	integer	Total de páginas

Objeto endpoint (item de data)

Atributo	Tipo	Descrição
`id`	string	`wbe_` (legados `wbh_`)
`name`	string	Nome descritivo
`endpoint`	string	URL HTTPS
`enabled`	boolean	Ativo
`events`	array \| null	Tipos de evento assinados
`forceActive`	boolean	Recebe todos os tipos de evento
`shotsQty`	integer	Total de disparos
`failedShotsQty`	integer	Disparos com falha
`lastDeliveryAt`	string (ISO) \| null	Última entrega
`metadata`	objeto \| null	Metadados
`createdAt` / `updatedAt`	string (ISO)	Timestamps
`_links`	object	HATEOAS (`self`)

Erros

Código HTTP	Quando
401	Chave de API ausente/inválida (`SelectKey`)
403	Sem o escopo `webhooks:list`
500	Erro interno

Melhores Práticas

Utilize os filtros (name, endpoint, status) para encontrar endpoints específicos.
Configure limit adequadamente (máximo 100) para otimizar suas requisições.
Monitore o campo lastDeliveryAt para identificar webhooks que não recebem eventos recentemente.
Verifique hasMore para determinar se há mais resultados além dos retornados.

Listar endpoints

On this page