GET /api/v1/webhook-endpoints/ - Chargefy

Retorna todos os endpoints de webhook configurados na organização.

Autenticação

Requer um token de acesso válido (CHARGEFY_ACCESS_TOKEN) no header Authorization.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
`page`	`integer`	Não	Número da página (default: 1)
`limit`	`integer`	Não	Itens por página (default: 10, máx: 100)
`organizationId`	`string`	Não	Filtrar por organização

Campos da Resposta

Campo	Tipo	Descrição
`items`	`array`	Lista de endpoints
`items[].id`	`string`	ID do endpoint
`items[].url`	`string`	URL do endpoint
`items[].events`	`array`	Lista de eventos
`items[].status`	`string`	Status
`items[].createdAt`	`datetime`	Data de criação
`pagination`	`object`	Informações de paginação

Exemplo de Requisição

curl -X GET "https://api.chargefy.io/api/v1/webhook-endpoints/" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

import { Chargefy } from '@chargefy/sdk';

const chargefy = new Chargefy({
  accessToken: process.env.CHARGEFY_ACCESS_TOKEN,
});

const endpoints = await chargefy.webhookEndpoints.list();

Exemplo de Resposta

{
  "items": [
    {
      "id": "we_abc123",
      "url": "https://meusite.com.br/webhooks/chargefy",
      "events": ["subscription.created", "checkout.updated"],
      "status": "active",
      "organizationId": "org_abc",
      "createdAt": "2026-03-12T10:00:00Z"
    }
  ],
  "pagination": {
    "total_count": 2,
    "max_page": 1
  }
}