RErecurrente
webhookEndpoints

Registrar un webhook endpoint

Changed on

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.

post/webhook_endpoints

Request

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

  • 33bad9197d59Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to array for status

  • 3d76463f9fd8Revision changes
    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API