VerifikaDocs
ReferenciaWebhooks

Crear un webhook

Devuelve el secreto de firma en claro. Guárdalo: con él verificas que cada entrega vino de nosotros. La URL tiene que ser https y resolver a una dirección pública — se valida al guardar y otra vez en cada entrega, porque un dominio que hoy apunta a un servidor público puede apuntar mañana a una red interna.

POST
/webhook-endpoints

Autorización

apiKey webhooks.write
AutorizaciónBearer <token>

La llave del negocio, creada en el panel: Integraciones → API pública. Formato vk_live_… (o vk_test_… fuera de producción).

Va en: header

Permiso: webhooks.write

Parámetros de consulta

companyId?string

Sobre qué negocio actúa la petición. Obligatorio solo si la llave entra a varios negocios (plan Multi); con uno solo, se deduce.

Cuerpo de la petición

application/json

Tipos de TypeScript

Usa el tipo request body en TypeScript.

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/webhook-endpoints" \  -H "Content-Type: application/json" \  -d '{    "url": "https://tusistema.com/verifika",    "description": "Producción",    "events": [      "income.verified",      "suspicious.created"    ]  }'
{  "object": "webhookEndpoint",  "id": "string",  "url": "http://example.com",  "description": "string",  "events": [    "string"  ],  "status": "ENABLED",  "consecutiveFailures": 0,  "lastSuccessAt": "string",  "lastFailureAt": "string",  "createdAt": "string",  "last24h": {    "delivered": 0,    "failed": 0  },  "secret": "string"}

Métricas del periodo GET

Los mismos cortes de la pantalla de Métricas: totales del periodo y del anterior, serie por día, perfil por hora, ranking por persona y por cuenta de recaudo. Acepta los filtros del libro. fromTime/toTime acotan a un turno (por ejemplo, 18:00–23:59 para la noche).

Eliminar un webhook DELETE

Siguiente