Skip to navigation
Referencia APIWebhook Endpoints

Registrar un webhook endpoint

Registra una nueva URL pública para recibir notificaciones de webhook cuando ocurran eventos en tu cuenta. No se aceptan direcciones privadas, locales ni de metadata. Con una llave TEST el endpoint se registra en el ambiente de prueba y solo recibe eventos simulados (live_mode: false); con una llave LIVE, en producción.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"

URL que recibirá las notificaciones de webhook

descriptionstringOptional

(Opcional) Descripción del endpoint

metadatamap from strings to stringsOptional

(Opcional) Metadata personalizada

Response

Webhook endpoint creado. El signingSecret solo se devuelve en esta respuesta de creación; si lo pierdes, debes consultarlo en el dashboard de Svix.

idstringOptional
ID del endpoint
urlstringOptionalformat: "uri"
URL que recibe los webhooks
descriptionstringOptional

Descripción del endpoint

disabledbooleanOptional

Si el endpoint está deshabilitado

metadatamap from strings to stringsOptional
Metadata personalizada
createdAtdatetimeOptional

Fecha de creación

updatedAtdatetimeOptional

Última actualización

signingSecretstringOptional
Secret para verificar las firmas de los webhooks. Solo se devuelve al crear el endpoint, no al listarlos.

Errors

422
Unprocessable Entity Error