ByDomuDevelopers

Disparar un evento de prueba

POSThttps://api.bydomu.com/v1/test/events

Encola la entrega de un evento del catálogo (GET /v1/events) a los webhooks de la organización de prueba suscritos a ese tipo, por la misma cola con reintentos y con la misma firma X-Domu-Signature que un evento real. Los datos salen del registro más reciente de ese objeto en la organización de prueba; si no hay ninguno, van con la forma del catálogo y valores nulos (synthetic: true). El sobre lleva livemode: false y test: true. Solo con una clave de prueba: con una de producción responde 403 TEST_MODE_ONLY.

Permiso que pide

webhooks:write

Encabezado obligatorio

X-API-Key · clave secreta

Nivel de acceso

Nivel 3 · con revisión de soporte

Encabezados

1 · todos opcionales
Idempotency-Keystring · opcional
Clave única de la operación (8-128 caracteres de [a-zA-Z0-9._:-]). Un reintento con la misma clave y el mismo cuerpo devuelve la respuesta original sin repetir la operación. Vive 24 horas.8–128 chars

Cuerpo (JSON)

1 · obligatorios
typestring · obligatorio
1–100 chars

Respuesta 201

TestEvent · 5 campos
dataid · type · livemode · webhooks · synthetic
idstringId del evento de prueba (`evt_test_…`)
typestring
livemodebooleanfalse
webhooksintegerWebhooks suscritos a ese tipo a los que se encoló la entrega
syntheticboolean`true` si no había registros de ese objeto y los datos van con valores nulos

Errores posibles

con la forma { "error": { "code", "message" } }
  • 400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.
  • 401UNAUTHORIZED
  • 402PAYMENT_REQUIRED
  • 403FORBIDDEN
  • 404NOT_FOUND
  • 409DUPLICATE
  • 429RATE_LIMITED
  • 500INTERNAL_ERROR
PeticiónPOST/v1/test/events
SDK oficial · @bydomu/sdk · aún no está en npm
import { ByDomu } from "@bydomu/sdk";

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

const { data } = await bydomu.test.triggerEvent({
  "type": "deal.won"
});
201 Created · ejemplo
{
  "data": {
    "id": "evt_test_5f3a0c1e7d2b4f7e9a510b6c1d2e3f40",
    "type": "deal.won",
    "livemode": false,
    "webhooks": 1,
    "synthetic": false
  }
}