Payload de ejemplo de un evento

GEThttps://api.bydomu.com/v1/webhooks/sample/{type}

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

El sobre exacto que recibiría un webhook para ese tipo. Usa el último evento REAL de la organización cuando existe (meta.synthetic: false); si no, arma uno con la forma del catálogo y valores nulos (meta.synthetic: true). Un tipo que no está en el catálogo responde 404.

Permissão

webhooks:write

Chaves

Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório

Sua chave secreta.

Parâmetros de rota

typestringobrigatório

Tipo exacto del catálogo

Respostas

200Payload de ejemplo

401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.

403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.

404NOT_FOUND · El recurso no existe en la organización.

429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.

500INTERNAL_ERROR · Error interno del servidor.

{ "data": { "id": "5f3a0c1e-7d2b-4f7e-9a51-0b6c1d2e3f40", "type": "deal.won", "timestamp": "2026-09-22T14:30:00.000Z", "organizationId": "clx1org001", "actor": { "kind": "USER", "userId": "clx1usr001" }, "data": { "deal": { "id": "clx1deal001", "title": "Venta Apto Chapinero" }, "contact": { "id": "clx1con001", "firstName": "María" } } }, "meta": { "synthetic": false } }