Webhooks

Los webhooks permiten suscribirse a los eventos en tu cuenta de Piriod para que tu integración pueda desencadenar acciones automáticamente.

Piriod usa webhooks para notificar a tu aplicación que un cierto evento se ha desencadenado en tu cuenta. Los webhooks son útiles para eventos asincrónicos como cuando se ha registrado un nuevo cliente, has recibido un nuevo pago o tienes una nueva suscripción.

No es necesario utilizar siempre los webhooks, estos deben ser usados cuando necesitas hacer cambios en tus aplicaciones apenas algo haya ocurrido en Piriod, por ejemplo:

  • Si tienes una nueva suscripción, deberías enterarte de inmediato para darle permisos a un usuario en tu sistema.

  • Si un pago está fallido, deberías enterarte de inmediato para quitar el acceso a tu producto o notificar a tu usuario.

Crear un webhook en 2 pasos:

  1. Crear un endpoint de webhook en tu servidor.

  2. Registrar el webhook en Piriod.

¿Qué son los webhooks?

Es un sistema de notificaciones para mantener sistemas integrados en base a eventos.

Usando una analogía, los webhooks son como un número de teléfono al que Piriod llama para contarle sobre ciertas cosas que están ocurriendo en la cuenta. Esas cosas podrían ser la creación de un nuevo cliente o un nuevo pago. El endpoint del webhook es la persona que responde a la llamada y que realiza ciertas acciones (lógica de negocio) en función de lo que le contamos en la llamada (información recibida).

Ahora, técnicamente el endpoint del webhook es un código alojado en su servidor y expuesto en una URL (por ejemplo, https://myproduct.com/webhooks), que podría estar escrito en Python, PHP, NodeJS, Ruby o lo que sea. Las notificaciones que envía Piriod a estos endpoints contienen información sobre lo que acaba de suceder, el tipo de evento y el identificador asociado al objeto con el cual dicho evento se ha gatillado. El endpoint de tu webhook debe utilizar dicha información para realizar las acciones necesarias, como por ejemplo dar un permiso a un usuario después de un pago exitoso.

¿Cuándo debes usar los webhooks?

Cuando tu aplicación necesita saber y actuar apenas ciertos eventos ocurren en tu cuenta de Piriod, como la cancelación de una suscripción o un pago fallido, puedes usar webhooks para notificar a tu aplicación. Las notificaciones de webhook generalmente se publican de forma asincrónica y, por lo tanto, no se recomiendan para aplicaciones de tiempo crítico. Cuando el tiempo es crítico, es mejor usar la API de Piriod para buscar eventos.

Eventos

Nombre del evento

Descripción

customer.created

Se activa cuando se crea un cliente.

customer.updated

Se activa cuando se actualiza un cliente.

invoice.created

Se activa cuando se crea una factura.

invoice.finalized

Se activa cuando una factura es finalizada (enviada a la agencia fiscal).

invoice.paid

Se activa cuando una factura es pagada.

invoice.updated

Se activa cuando se actualiza una factura.

payment.created

Se activa cuando se crea un pago.

payment.succeeded

Se activa cuando un pago es pagado.

payment.updated

Se activa cuando se actualiza un pago.

source.created

Se activa cuando se crea una fuente de pago.

source.stored

Se activa cuando una fuente de pago (tarjeta de crédito / débito) es registrada exitosamente.

source.updated

Se activa cuando se actualiza una fuente de pago.

subscription.created

Se activa cuando se crea una suscripción.

subscription.updated

Se activa cuando se actualiza una suscripción.