Skip to main content
When the merchant enables proofing on a Workflow, the Element renders a visual soft-proof of the file after automated changes (for example, RGB to CMYK conversion or a padded canvas) and asks the customer to sign off.

The proof event

The Element fires proof once pages are rendered:
interface ProofPayload {
  pages: Array<{ url: string; page: number; width: number; height: number; mimeType: string; bytes: number; key: string }>;
  approvalRequired?: boolean;  // if true, the workflow halts until respondToProof() is called
  message?: string;
  affirmButtonText?: string;
}
intake.on('proof', ({ pages, approvalRequired }) => {
  if (!approvalRequired) return; // informational only

  showProofGallery(pages, {
    onApprove: () => intake.respondToProof(true),
    onReject:  () => intake.respondToProof(false),
  });
});
If you don’t build a custom gallery, ignore the proof event. The built-in iframe gallery handles approval automatically.
See Events for the full event list.