Skip to main content

Workspace

The top-level account container. A workspace has members (with roles), templates, passes, projects, access tokens, webhooks, billing, and security policy. You can belong to several workspaces and switch between them under Settings → Workspaces. Every workspace has an immutable Workspace ID, visible under Settings → General and used in API requests and webhooks.

Template

A reusable pass design: colors, logos, layout, fields, and barcode, everything every pass issued from it will look like. A template targets Apple Wallet, Google Wallet, or both, and each wallet has its own designer with a live preview. Templates are versioned:
  • A template is a Draft until you publish it; publishing creates an immutable published version (v1, v2, and so on).
  • Passes are always issued from, and stay pinned to, a specific published version, so a later redesign never silently changes passes already in wallets.
  • You can upgrade issued passes to a newer version explicitly.

Variable

A named placeholder defined on a template (text, integer, date/time, or a single or multiple choice) and bound into pass fields. Variables are filled in per pass at issue time (attendeeName, tier, seat) and can be updated later on issued passes. Variable names carry no special behavior. The scannable barcode payload comes from whichever variable you pick in the template editor’s Scanner properties (or from a Passlet-generated signed code), and per-pass validity comes from the template’s redemption rule, which can reference your date variables.

Pass

An individual issued wallet credential, created from a published template version. A pass has:
  • a Label: the holder’s display name,
  • an External Pass ID: your system’s reference, also used for idempotency,
  • a status: shown in the console as Queued, Pending, Issued, Voided, Failed, or Expired,
  • variable values, a revision history, add-to-wallet links, and a scan history.
Every issued pass exposes hosted links, one per wallet provider, that add the pass to Apple Wallet or Google Wallet. You distribute these links however you like. Links can be resent (regenerated, invalidating the old ones) or revoked. See Distributing passes.

Project

An organizational container that groups templates and the passes issued from them. Projects are useful for separating campaigns, business lines, or per-customer deployments. Templates without a project appear as Uncategorised; passes always inherit their template’s project. See Projects.

Redemption rule

A template-level policy that controls when a pass can be scanned (always, during date windows, or after first scan) and how often (recurring limits, cooldowns, lifetime totals, optionally auto-voiding the pass once its lifetime total is spent). It is enforced server-side at scan time and projected into the wallet’s native validity fields. See Redemption and scanning.

Scanner device

A mobile device running the Passlet Scanner app, connected to your workspace by scanning a setup QR. Scanner devices authenticate with scoped credentials, never sign in to the admin console, and can be revoked at any time from the Scanner app page.

Access token

An API key (plt_...) that authenticates external systems against the public REST API. Tokens carry scopes (for example passes:write or scans:read) that limit what they can do. See Access tokens.

Webhook

An HTTPS endpoint you register to receive pass lifecycle events (pass.issued, pass.updated, pass.voided, pass.failed, pass.scanned), with signed payloads and per-delivery tracking. See Webhooks.

How it all fits together