Uso de Suscripciones

Las suscripciones son útiles para experiencias de usuario en tiempo real, tales como:

• progreso de carga
• progreso de tareas asíncronas
• actualizaciones del ciclo de vida de documentos y destinatarios
• cambios de crédito

Para el esquema del payload en sí, consulte:

• Conectar a Suscripciones AppSync
• Formato del Evento de Suscripción
• Esquema del Evento de Suscripción

Analizar el Payload Interno del Evento

El campo de suscripción devuelve:

• un envoltorio de entrega (userId o groupId)
• una cadena JSON en data

Siempre analice el valor interno de data antes de manejar el evento.

const parseEnvelope = (payload) => {
  const raw = payload?.data;
  if (!raw) return null;
  return typeof raw === 'string' ? JSON.parse(raw) : raw;
};

Enrutamiento por category y event

Trate:

• category como la familia del evento
• event como la acción específica o estado del flujo de trabajo

Ejemplos:

• category: "upload", event: "uploadCompleted"
• category: "task", event: "taskCreditBlocked"
• category: "documentLifecycle", event: "documentCreated"
• category: "recipientLifecycle", event: "recipientVisiting"

Reglas de Entrega

• subscribeUserFeed se usa para eventos dirigidos a usuarios, tales como progreso de carga y algunas propagaciones de ciclo de vida.
• subscribeGroupFeed se usa para eventos dirigidos a grupos, tales como actualizaciones de documentos, destinatarios, plantillas, tareas, créditos y ciclo de vida.
• Algunos eventos se propagan a ambos feeds con el mismo eventId.

Guía de Compatibilidad

Si está migrando desde los payloads de suscripción antiguos y planos:

• analice primero el sobre interno data
• cambie el enrutamiento de eventos a event en lugar del legado systemMessage
• use category para decidir cómo interpretar data
• continúe ignorando campos desconocidos en data

Nombres Representativos de Eventos

Los nombres comunes de eventos incluyen:

• documentArchived
• documentCancelled
• recipientUpdated
• recipientReset
• documentCreated
• documentFinalPdfCreated
• documentRejected
• recipientSentEmail
• recipientVisiting
• recipientCompleted
• recipientRejected
• recipientEmailOpened
• taskDocumentCreated
• taskCompleted
• taskStoppedByRecipientStopList
• taskTrialCreditBlocked
• taskCreditBlocked
• templateArchived
• templateUpdated
• templateElementCreated
• templateElementUpdated
• templateElementDeleted
• templateRoleCreated
• templateRoleUpdated
• templateRoleDeleted
• uploadScanned
• uploadTypeChecked
• uploadConverting
• uploadFlattened
• uploadTagsParsed
• uploadPdfMetaExtracted
• uploadCompleted
• uploadFailed
• creditUpdated

Guías dedicadas para flujos de trabajo:

• Seguimiento del Progreso de Carga con Suscripciones
• Seguimiento de Tareas de Envío con Suscripciones
• Seguimiento del Ciclo de Vida de Documentos y Destinatarios con Suscripciones