Treli API
Docs
Soporte
  1. Eventos
  • Introducción
  • Autenticación
  • Errores
  • Suscripciones
    • Suscripción
    • Crear suscripción
      POST
    • Actualizar suscripción
      POST
    • Cancelar suscripción
      POST
    • Obtener suscripción
      GET
    • Eliminar descuento
      DELETE
    • Pausar suscripción
      POST
    • Reanudar suscripción
      POST
  • Items de suscripción
    • Obtener item de suscripción
      GET
    • Eliminar item de suscripción
      DELETE
    • Actualizar item de suscripción
      POST
    • Crear item de suscripción
      POST
  • Clientes
    • Cliente
    • Crear cliente
      POST
    • Actualizar cliente
      POST
    • Obtener cliente
      GET
  • Cobros
    • Cobro
    • Crear cobro
      POST
    • Registrar cobro parcial
      POST
    • Enviar notificación de cobro
      POST
    • Anular cobro
      POST
    • Marcar como incobrable
      POST
    • Pagar un cobro
      POST
    • Obtener un cobro
      GET
  • Facturas
    • Cargar factura
    • Obtener factura
  • Eventos
    • Evento
    • Tipos de eventos
  1. Eventos

Evento

Los eventos son nuestra forma de avisarte cuando algo interesante ocurre en tu cuenta. Cuando ocurre un evento interesante, creamos un nuevo objeto de evento. Por ejemplo, si un transacción se es exitosa, creamos un evento charge.approved, si falla un intento de pago de un cobro, creamos un evento collection.payment_failed, si vence una factura, creamos un evento invoice.past_due, y si una nueva suscripción es activada, creamos un evento subscription.activated. Algunas solicitudes de API pueden crear varios eventos. Por ejemplo, si creas una nueva suscripción para un cliente, recibirás los siguientes eventos: subscription.created, collection.created y transaction.created.
Al igual que con otros recursos de la API, puedes usar endpoints para recuperar un evento individual o una lista de eventos de la API. También contamos con un sistema de webhooks independiente para enviar los objetos de evento directamente a un endpoint en tu servidor. Puedes administrar los webhooks en la configuración de tu cuenta.
Solo garantizamos el acceso a los eventos a través de la API de Obtener un evento durante 30 días.

Objeto de evento#

Evento
id
string 
required
Identificador único del objeto.
Example:
evt_1NG8Du2eZvKYlo2CUI79vXWy
api_version
string 
required
La version de la API de Treli utilizada para representar los datos.
Example:
v1
is_test
boolean 
required
Tiene el valor false si el objeto existe en modo en producción o el valor true si el objeto existe en modo de prueba
Example:
false
type
string 
required
Descripción del event (por ejemplo, subscription.created o collection.created.
Example:
subscription.created
data
object 
required
Objeto que contiene el recurso de API relevante para el evento. Por ejemplo, un evento subscription.created tendrá un objeto de suscripción como valor.
Previous
Obtener factura
Next
Tipos de eventos
Built with