Skip to main content
GET
Listar webhooks
Requer a permissão WEBHOOK:READ.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

Busca por nome, ID ou endpoint do webhook

Example:

"pagamentos"

after
string

Cursor para buscar itens após este ponto

before
string

Cursor para buscar itens antes deste ponto

limit
integer
default:100

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

Required range: 1 <= x <= 100
Example:

100

id
string

Filtrar por identificador único do webhook

Example:

"webh_abc123xyz"

Response

Lista de webhooks retornada com sucesso.

data
object[]

Lista de webhooks.

success
boolean

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

Example:

true

error
string | null
Example:

null

pagination
object

Informações de paginação baseada em cursor.