Skip to main content
Piriod utiliza webhooks para notificar a tu aplicación cuando se activa un evento específico en tu cuenta. Imagina un endpoint de webhook como un número de teléfono al que Piriod llama para informar sobre sucesos en tiempo real: un nuevo cliente, un pago completado o un cambio de suscripción. Tu endpoint es el código que responde a la llamada y actúa en función de la información recibida. Técnicamente, un endpoint de webhook es un código alojado en tu servidor y expuesto en una URL pública (por ejemplo, https://myproduct.com/webhooks). Puede estar escrito en Python, PHP, Node.js, Ruby o cualquier otro lenguaje. Cuando se activa un evento, Piriod envía una solicitud POST a tu endpoint con una payload JSON que contiene el nombre del evento y el ID del objeto que lo activó. Tu endpoint utiliza esa información para ejecutar la lógica de negocio correspondiente; por ejemplo, otorgar acceso a un usuario después de un pago exitoso.

​
Cuándo usar webhooks

Utiliza webhooks cuando tu aplicación necesite actuar tan pronto como ocurra algo en organización de Piriod. Algunos casos de uso comunes incluyen:
  • Nueva suscripción - otorgar acceso a un usuario en su sistema en el momento en que se crea una suscripción.
  • Pago fallido - revocar el acceso a su producto o notificar al usuario inmediatamente cuando falle un pago.
Las notificaciones de webhook se entregan de forma asíncrona y no se recomiendan para aplicaciones críticas en cuanto al tiempo. Cuando el tiempo es crucial, utilice la API de Piriod para obtener los eventos directamente.

​
Configuración en dos pasos

Configurar webhooks requiere dos pasos:
  1. Crear un webhook en tu servicio.
  2. Registrar un webhook en tu organización de Piriod.

​
Eventos disponibles

La tabla que aparece a continuación enumera todos los eventos que Piriod puede enviar a tu endpoint.
Event nameDescription
customer.createdSe activa cuando se crea un cliente.
customer.updatedTriggered when a customer is updated.
invoice.createdTriggered when an invoice is created.
invoice.finalizedTriggered when an invoice is finalized (submitted to the tax authority).
invoice.paidTriggered when an invoice is paid.
invoice.updatedTriggered when an invoice is updated.
payment.createdTriggered when a payment is created.
payment.succeededTriggered when a payment succeeds.
payment.updatedTriggered when a payment is updated.
source.createdTriggered when a payment source is created.
source.storedTriggered when a payment source (credit/debit card) is successfully stored.
source.updatedTriggered when a payment source is updated.
subscription.createdTriggered when a subscription is created.
subscription.updatedTriggered when a subscription is updated.