Payload de ejemplo de un evento

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

This reference is generated from the API’s code, so descriptions are in Spanish. Names, parameters and examples are the same in every language.

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.

Permission
webhooks:write
Keys
Secret only (server-side)

Headers

X-API-Keystringrequired
Your secret key.

Path parameters

typestringrequired
Tipo exacto del catálogo

Responses

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.
cURL
curl "https://api.bydomu.com/v1/webhooks/sample/deal.won" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/webhooks/sample/deal.won", {
  headers: { "X-API-Key": process.env.BYDOMU_API_KEY },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.bydomu.com/v1/webhooks/sample/deal.won",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Response · 200 · example
{
  "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
  }
}

The key goes in the BYDOMU_API_KEY variable. The example data belongs to no agency.