Saltar al contenido principal
Los eventos registran cambios significativos en los recursos de tu organización. Cuando algo cambia, Syntage crea un recurso Event. Por ejemplo, enviar la credencial del SAT de una entidad puede crear eventos de credencial y de entidad, y una extracción completada puede crear un evento extraction.updated. Muchas solicitudes pueden crear más de un evento. Por ejemplo, enviar credenciales válidas del SAT para una entidad puede crear eventos credential.created, credential.updated y link.created. Los eventos ocurren cuando el estado de otro recurso cambia. El estado de ese recurso al momento del cambio se incluye en el campo data del evento. Por ejemplo, un evento credential.updated contiene una Credential, y un evento invoice.updated contiene un Invoice. Usa los endpoints de Events para recuperar eventos recientes directamente. Usa webhooks cuando quieras que Syntage entregue eventos a tu servidor automáticamente.
El acceso a los eventos solo está garantizado durante 7 días.
Los eventos del ciclo de vida de las entidades aún usan los nombres de tipo link.* por compatibilidad.

Cómo se usan los eventos

  1. Suscríbete a webhooks cuando tu integración necesite reaccionar automáticamente a cambios en los recursos.
  2. Almacena el ID del evento de cada solicitud webhook o respuesta de Events para que tu integración pueda deduplicar el procesamiento.
  3. Usa type para enrutar el evento al manejador correcto.
  4. Usa resource para recuperar la versión actual del recurso modificado cuando sea necesario.
  5. Usa data.object cuando necesites el estado del recurso capturado al momento en que se creó el evento.
Los endpoints de Events son útiles para backfills, depuración y conciliación. Los webhooks son la mejor opción para la entrega continua. Para detalles de implementación, consulta Ejemplos de eventos.

Tipos de eventos

El sufijo describe el tipo de cambio: