v3

latestOpenAPI 3.1.02026-08-044524163.2 KB

Listar webhooks

Retorna todos os webhooks da sua loja com suporte a paginação e busca.

Alternativa: Você também pode visualizar e gerenciar seus webhooks pelo Dashboard da AbacatePay.

get/webhooks/list

Query parameters

searchstring

Example:pagamentos

Busca por nome, ID ou endpoint do webhook

afterstring

Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).

beforestring

Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).

limitinteger

Example:100

Quantidade de itens por página (1-100).

startDatestring date

Example:2026-01-01

Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).

endDatestring date

Example:2026-01-31

Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).

idstring

Example:webh_abc123xyz

Filtrar por identificador único do webhook

Response

Lista de webhooks retornada com sucesso.

successboolean

Se a requisição obteve sucesso ou não.

errorstring nullable

Example response

{
  "data": [
    {
      "id": "webh_abc123xyz",
      "name": "Webhook de Pagamentos",
      "endpoint": "https://meusite.com/webhooks/abacatepay",
      "events": [
        "checkout.completed",
        "subscription.renewed"
      ],
      "v2": true,
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z"
    }
  ],
  "success": true
}