webhookEndpoints

Registrar un webhook endpoint

Registra una nueva URL para recibir notificaciones de webhook cuando ocurran eventos en tu cuenta. 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.

post/webhook_endpoints

Headers

X-SECRET-KEYstring required

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.

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 body

urlstring uri required

URL que recibirá las notificaciones de webhook

descriptionstring

(Opcional) Descripción del endpoint

metadataobject

(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.

idstring

ID del endpoint

urlstring uri

URL que recibe los webhooks

descriptionstring

Descripción del endpoint

disabledboolean

Si el endpoint está deshabilitado

metadataobject

Metadata personalizada

createdAtstring date-time

Fecha de creación

updatedAtstring date-time

Última actualización

signingSecretstring

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.