1. Webhooks (Gerenciar Endpoints)
Dotfy - Documentação
  • Dotfy Module
    • Raiz
      • Conta (Dados do Seller)
        • Identificar a conta (dados do seller)
      • Cobranças PIX
        • Criar cobrança PIX
        • Listar cobranças
        • Consultar cobrança por correlationID
        • Histórico de webhooks de uma cobrança
      • Cartão (Checkout Transparente)
        • Criar pagamento com cartão (PAN via API)
      • Saldo
        • Consultar saldo
      • Saques e Chaves PIX
        • Listar chaves PIX cadastradas
        • Cadastrar chave PIX
        • Listar saques
        • Solicitar saque
        • Cancelar saque pendente
      • Clientes
        • Listar clientes
        • Detalhe de um cliente
      • Produtos e Links de Pagamento
        • Links de compra por comprador (Purchase Links)
          • Criar link de compra (por comprador)
          • Listar links de compra do produto
          • Detalhe/status do link de compra
          • Revogar link de compra
        • Listar produtos
        • Criar produto
        • Detalhe do produto
        • Carrinhos abandonados do produto
      • Splits
        • Analytics de splits enviados
        • Splits recebidos
      • Disputas e MEDs
        • Listar disputas
        • Listar MEDs com estatísticas
        • Evidências de uma disputa
        • Histórico de uma disputa
      • Subcontas White-Label (BaaS)
        • Criar subconta
        • Listar subcontas
        • Detalhe da subconta
        • Atualizar subconta
        • Excluir subconta (soft delete)
        • Enviar KYC da subconta (multipart)
        • Consultar status do KYC da subconta
        • Cadastrar chave PIX da subconta
        • Listar chaves PIX da subconta
        • Remover chave PIX da subconta
        • Criar cobrança da subconta
        • Listar cobranças da subconta
        • Detalhe de cobrança da subconta
        • Saldo da subconta
        • Extrato (transações) da subconta
        • Solicitar saque da subconta
        • Listar saques da subconta
        • Atualizar taxas da subconta
      • Webhooks (Gerenciar Endpoints)
        • Listar endpoints
          GET
        • Criar endpoint
          POST
        • Atualizar endpoint
          PATCH
        • Remover endpoint
          DELETE
      • Webhooks (Eventos Recebidos)
        • EVENT:CHARGE_CREATED — cobrança criada
        • EVENT:CHARGE_PAID — cobrança paga (atualização principal)
        • EVENT:CHARGE_EXPIRED — cobrança expirada
        • EVENT:SPLIT_RECEIVED — você recebeu um split
        • EVENT:DISPUTE_OPENED — MED/disputa aberta
        • EVENT:DISPUTE_WON — disputa ganha
        • EVENT:DISPUTE_LOST — disputa perdida
        • EVENT:DISPUTE_CANCELED — disputa cancelada
        • EVENT:WITHDRAWAL_COMPLETED — saque concluído
        • EVENT:WITHDRAWAL_FAILED — saque falhou
        • EVENT:SUBACCOUNT_KYC_APPROVED — KYC da subconta aprovado
        • EVENT:SUBACCOUNT_KYC_REJECTED — KYC da subconta recusado
        • EVENT:SUBACCOUNT_PIX_KEY_APPROVED — chave PIX da subconta aprovada
        • EVENT:SUBACCOUNT_PIX_KEY_REJECTED — chave PIX da subconta recusada
      • Notificações
        • Listar notificações
      • Dashboard / Analytics
        • Stats gerais
        • Atividade recente
        • Atividade (timeline)
        • Receita por período
        • Volume por período
        • Taxa de conversão
        • Métodos de pagamento
        • Transações (gráfico)
        • Analytics avançado
  1. Webhooks (Gerenciar Endpoints)

Criar endpoint

POST
/api/webhook-endpoints

Autenticação#

Esta rota exige Bearer Token (sua API Key) no header. Envie EXATAMENTE assim:
Substitua o valor após Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.

Escopo: webhooks:write. Limite: 10 endpoints por conta.
A resposta inclui o secret — guarde-o, ele é mostrado uma única vez e é necessário para validar a assinatura HMAC-SHA256 enviada pelo gateway no header X-Webhook-Signature em cada webhook recebido. Veja a pasta "Webhooks (Eventos Recebidos)" para o snippet de validação.

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/webhook-endpoints' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Backend produção",
  "url": "https://api.suaempresa.com.br/webhooks/dotfy",
  "events": [
    "EVENT:CHARGE_CREATED",
    "EVENT:CHARGE_PAID",
    "EVENT:CHARGE_EXPIRED",
    "EVENT:DISPUTE_OPENED",
    "EVENT:DISPUTE_WON",
    "EVENT:DISPUTE_LOST",
    "EVENT:WITHDRAWAL_COMPLETED",
    "EVENT:WITHDRAWAL_FAILED",
    "EVENT:SPLIT_RECEIVED"
  ]
}'
Response Response Example
{
  "success": true,
  "data": {
    "id": "clwh0001",
    "name": "Backend produção",
    "url": "https://api.suaempresa.com.br/webhooks/dotfy",
    "secret": "whsec_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "events": ["EVENT:CHARGE_PAID", "EVENT:CHARGE_EXPIRED"],
    "isActive": true,
    "createdAt": "2026-05-07T14:30:00.000Z"
  }
}
Modificado em 2026-07-02 06:57:27
Página anterior
Listar endpoints
Próxima página
Atualizar endpoint
Built with