Referencia APIWebhook Endpoints

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.

Authentication

X-SECRET-KEYstring
Tu clave secreta de API

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.

idstring
ID del endpoint
urlstringformat: "uri"
URL que recibe los webhooks
descriptionstring

Descripción del endpoint

disabledboolean

Si el endpoint está deshabilitado

metadatamap from strings to strings
Metadata personalizada
createdAtdatetime

Fecha de creación

updatedAtdatetime

Última actualización

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