Criar endpoint
POST
{{base_url}}/api/webhook-endpoints
Autenticação
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.webhooks:write. Limite: 10 endpoints por conta.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
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '{{base_url}}/api/webhook-endpoints' \
--header 'Authorization: Bearer {{api_key}}' \
--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-05-07 16:12:35