ByDomuDevelopers
Create key

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 required

webhooks:write

Required header

X-API-Key · secret key

Access level

Level 3 · with support review

Path parameters

1 · required
typestring · required
Tipo exacto del catálogo

Response 200

object · 7 fields
dataid · type · timestamp · organizationId · livemode · actor · data
idstring`evt_sample` en los ejemplos sintéticos
typestring
timestampstring
organizationIdstring
livemodeboolean`false` si el evento salió de la organización de prueba (clave `_test_`)
actorkind · userId
kindstringUSER, NOA, SYSTEM, API, AUTOMATION, INTEGRATION
userIdstring
dataanyPayload del evento: un objeto por cada objeto del catálogo
metasynthetic
syntheticboolean`true` si es un ejemplo armado con valores nulos

Possible errors

shaped as { "error": { "code", "message" } }
  • 401UNAUTHORIZED
  • 403FORBIDDEN
  • 404NOT_FOUND
  • 429RATE_LIMITED
  • 500INTERNAL_ERROR
RequestGET/v1/webhooks/sample/{type}
Official SDK · @bydomu/sdk · not on npm yet
import { ByDomu } from "@bydomu/sdk";

const bydomu = new ByDomu({
  apiKey: process.env.BYDOMU_API_KEY,
});

const { data } = await bydomu.webhooks.getSample("deal.won");
200 OK · example
{
  "data": {
    "id": "5f3a0c1e-7d2b-4f7e-9a51-0b6c1d2e3f40",
    "type": "deal.won",
    "timestamp": "2026-09-22T14:30:00.000Z",
    "organizationId": "clx1org001",
    "livemode": true,
    "actor": {
      "kind": "USER",
      "userId": "clx1usr001"
    },
    "data": {
      "deal": {
        "id": "clx1deal001",
        "title": "Venta Apto Chapinero"
      },
      "contact": {
        "id": "clx1con001",
        "firstName": "María"
      }
    }
  },
  "meta": {
    "synthetic": false
  }
}