Verwendung von Subscriptions

Subscriptions sind nützlich für Echtzeit-UX wie:

• Upload-Fortschritt
• asynchroner Aufgabenfortschritt
• Dokument- und Empfänger-Lifecycle-Updates
• Kreditänderungen

Für das Payload-Schema selbst siehe:

• Connect to AppSync Subscriptions
• Subscription Event Format
• Subscription Event Schema

Inneres Event-Payload parsen

Das Subscription-Feld liefert:

• eine Zustellhülle (userId oder groupId)
• einen JSON-String in data

Parsen Sie immer zuerst den inneren data-Wert, bevor Sie das Event verarbeiten.

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

Routen nach category und event

Behandle:

• category als Event-Familie
• event als die spezifische Aktion oder den Workflow-Zustand

Beispiele:

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

Zustellregeln

• subscribeUserFeed wird für benutzerorientierte Events wie Upload-Fortschritt und einige Lifecycle-Fanouts verwendet.
• subscribeGroupFeed wird für gruppenorientierte Events wie Dokument-, Empfänger-, Vorlage-, Aufgaben-, Kredit- und Lifecycle-Updates verwendet.
• Einige Events werden mit derselben eventId an beide Feeds gesendet.

Kompatibilitätshinweise

Wenn Sie von den älteren flachen Subscription-Payloads migrieren:

• parsen Sie zuerst die innere data-Hülle
• verschieben Sie die Ereignisleitung zu event anstelle des veralteten systemMessage
• verwenden Sie category, um zu entscheiden, wie data interpretiert wird
• ignorieren Sie weiterhin unbekannte data-Felder

Repräsentative Event-Namen

Häufige Event-Namen sind:

• 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

Spezielle Workflow-Anleitungen:

• Track Upload Progress with Subscriptions
• Track Send Tasks with Subscriptions
• Track Document and Recipient Lifecycle with Subscriptions