AbacatePay Webhooks API
The Webhooks API from AbacatePay — 4 operation(s) for webhooks.
The Webhooks API from AbacatePay — 4 operation(s) for webhooks.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/abacatepay:abacatepay-webhooks-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: AbacatePay Webhooks API
description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
version: 1.0.0
servers:
- url: https://api.abacatepay.com/v2
description: Único servidor para os ambientes de produção e sandbox.
tags:
- name: Webhooks
paths:
/webhooks/create:
post:
summary: Criar um webhook
description: 'Cria um novo webhook para receber notificações automáticas de eventos da sua loja.
O `endpoint` deve ser uma URL HTTPS válida e não pode apontar para endereços locais ou IPs privados.
**Alternativa**: Você também pode criar e gerenciar seus webhooks pelo Dashboard da AbacatePay.'
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookCreateInput'
responses:
'200':
description: Webhook criado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/WebhookResponse'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro descrevendo o motivo da falha na autenticação.
example: Token de autenticação inválido ou ausente.
tags:
- Webhooks
operationId: postWebhooksCreate
x-operation-id-source: derived
/webhooks/list:
get:
summary: Listar webhooks
description: '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.'
security:
- bearerAuth: []
parameters:
- name: search
in: query
description: Busca por nome, ID ou endpoint do webhook
required: false
schema:
type: string
example: pagamentos
- $ref: '#/components/parameters/QueryAfter'
- $ref: '#/components/parameters/QueryBefore'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryStartDate'
- $ref: '#/components/parameters/QueryEndDate'
- name: id
in: query
description: Filtrar por identificador único do webhook
required: false
schema:
type: string
example: webh_abc123xyz
responses:
'200':
description: Lista de webhooks retornada com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: Lista de webhooks.
items:
$ref: '#/components/schemas/WebhookResponse'
success:
$ref: '#/components/schemas/Success'
error:
type: string
nullable: true
example: null
pagination:
$ref: '#/components/schemas/PaginationCursor'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro descrevendo o motivo da falha na autenticação.
example: Token de autenticação inválido ou ausente.
tags:
- Webhooks
operationId: getWebhooksList
x-operation-id-source: derived
/webhooks/get:
get:
summary: Buscar um webhook
description: Retorna os dados de um webhook específico pelo seu identificador.
security:
- bearerAuth: []
parameters:
- name: id
in: query
description: Identificador único do webhook
required: true
schema:
type: string
example: webh_abc123xyz
responses:
'200':
description: Webhook encontrado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/WebhookResponse'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro descrevendo o motivo da falha na autenticação.
example: Token de autenticação inválido ou ausente.
'404':
description: Webhook não encontrado.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro indicando que o webhook não foi encontrado.
example: Webhook não encontrado.
tags:
- Webhooks
operationId: getWebhooksGet
x-operation-id-source: derived
/webhooks/delete:
post:
summary: Deletar um webhook
description: 'Remove um webhook da sua loja.
Esta operação é irreversível. Use com cuidado.'
security:
- bearerAuth: []
parameters:
- name: id
in: query
required: true
description: Identificador único do webhook a ser deletado
schema:
type: string
example: webh_abc123xyz
responses:
'200':
description: Webhook deletado com sucesso. A resposta de sucesso não traz o campo `data`.
content:
application/json:
schema:
type: object
properties:
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro descrevendo o motivo da falha na autenticação.
example: Token de autenticação inválido ou ausente.
'404':
description: Webhook não encontrado.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro indicando que o webhook não foi encontrado.
example: Webhook não encontrado.
tags:
- Webhooks
operationId: postWebhooksDelete
x-operation-id-source: derived
components:
parameters:
QueryAfter:
name: after
in: query
description: Cursor para buscar itens após este ponto (use o `publicId` retornado em `pagination.next`).
required: false
schema:
type: string
QueryBefore:
name: before
in: query
description: Cursor para buscar itens antes deste ponto (use o `publicId` retornado em `pagination.before`).
required: false
schema:
type: string
QueryEndDate:
name: endDate
in: query
description: '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).
'
required: false
schema:
type: string
format: date
example: '2026-01-31'
QueryLimit:
name: limit
in: query
description: Quantidade de itens por página (1-100).
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 100
example: 100
QueryStartDate:
name: startDate
in: query
description: '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).
'
required: false
schema:
type: string
format: date
example: '2026-01-01'
schemas:
WebhookResponse:
type: object
description: Os dados do webhook.
required:
- id
- name
- endpoint
- events
- devMode
- v2
- createdAt
- updatedAt
additionalProperties: false
properties:
id:
type: string
description: Identificador único do webhook
example: webh_abc123xyz
name:
type: string
description: Nome identificador do webhook
example: Webhook de Pagamentos
endpoint:
type: string
description: URL HTTPS que recebe as notificações de eventos
example: https://meusite.com/webhooks/abacatepay
events:
type: array
description: Lista de eventos subscritos
items:
type: string
example:
- checkout.completed
- subscription.renewed
devMode:
type: boolean
description: Indica se o webhook foi criado em ambiente de testes
example: false
v2:
type: boolean
description: Indica se o webhook usa o formato de payload v2
example: true
createdAt:
type: string
format: date-time
description: Data de criação do webhook
example: '2025-01-01T00:00:00.000Z'
updatedAt:
type: string
format: date-time
description: Data da última atualização do webhook
example: '2025-01-01T00:00:00.000Z'
Success:
type: boolean
description: Se a requisição obteve sucesso ou não.
example: true
WebhookCreateInput:
type: object
description: Dados para criação de um webhook.
required:
- name
- endpoint
- secret
- events
additionalProperties: false
properties:
name:
type: string
description: Nome identificador do webhook
example: Webhook de Pagamentos
endpoint:
type: string
description: URL HTTPS que receberá as notificações de eventos
example: https://meusite.com/webhooks/abacatepay
secret:
type: string
description: Sua chave usada para autenticar nosso webhook
example: meu-secret-seguro
events:
type: array
description: Lista de eventos que este webhook deve receber
items:
type: string
enum:
- checkout.completed
- checkout.refunded
- checkout.disputed
- checkout.lost
- transparent.completed
- transparent.refunded
- transparent.disputed
- transparent.lost
- subscription.completed
- subscription.trial_started
- subscription.cancelled
- subscription.renewed
- payout.completed
- payout.failed
- transfer.completed
- transfer.failed
example:
- checkout.completed
- subscription.renewed
PaginationCursor:
type: object
description: Informações de paginação baseada em cursor.
required:
- hasMore
- next
- before
additionalProperties: false
properties:
hasMore:
type: boolean
description: Indica se existe uma próxima página.
next:
type: string
nullable: true
description: Cursor da próxima página (usar em `after`). `null` na última página.
before:
type: string
nullable: true
description: Cursor da página anterior (usar em `before`). `null` na primeira página.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: '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](/pages/authentication).
'