Glossary
Use this glossary to connect maxclicks terminology to the decisions your team makes. Follow each reference for the controls, limits and examples behind the definition.
Space and data model
- Space: the workspace that owns your customer data, campaigns, members and billing. Check which space you are in before importing or sending. See workspace.
- Schema: the definition of a kind of record and its fields, such as Customer or Order. Its type is contact, object or business event. See schemas.
- Stored attribute: a fact saved on a record, such as a plan or renewal date. A configured missing-value policy applies when a record is created. See attributes.
- Evaluated attribute: a related record or calculated answer resolved on demand by its generated definition. “Evaluated on demand” is the type in the app. See evaluated attributes.
- Computed attribute / Trait: a recurring measurement published by a background calculation, such as a customer's purchase count in a rolling window. A value can be missing or stale; selecting it does not force a new calculation. See computed attributes.
- Attribute expansion: explicitly requesting evaluated or computed values, and any related records, for the data an email or workflow uses. Ordinary public record reads do not include those expanded values. See attribute expansion.
- Record: one entry following a schema. An internal record ID, your product's external identifier and a person's email are different identifiers with different matching rules. See records.
The three record types
- Contact: a person your team can email, with identity fields, marketing subscriptions and email statistics. See contacts.
- Object: a business entity such as an order, subscription or product. It can supply context but is not itself an email recipient. See objects.
- Business event: an occurrence such as PurchaseCompleted. Its accepted payload is immutable. Acceptance and readiness for downstream workflows are separate states. See events.
Collected event is a versioned behavioral collection contract configured in Events, with a source, event key, associated subject, and Properties and Context schemas. It is separate from a business event schema. See Collected events.
Track is the typed activity definition used by the collection catalog. Collected events build on that catalog, but a generic Track definition does not automatically have the collected event's nested payload contract or source credentials. See maxinja's catalog tools.
An event's subject identifies the contact or object the occurrence belongs to. A custom property containing an email address does not by itself establish that authoritative link. A correlation ID can connect occurrences from the same journey or transaction; it does not replace the subject's identity.
Audiences and messages
- Segment: a saved filter over one contact schema. It describes a rule; matching contacts can change with the data. See segments.
- Template: a reusable email with expected data and recipient configuration, commonly sent from your product through the API. Workflow email steps own their own email content. See templates.
- Broadcast: a one-time audience campaign with its own email and delivery schedule. Preparation fixes a campaign revision and recipient selection. See broadcasts.
- Brand kit: published design assets, palettes, typography, footer and voice guidance. Saved edits change the live kit; they do not rewrite sent emails or frozen campaign content. See brand kits.
- Sample data: the values used to review an email in the editor. Editing a sample does not change a customer record. See sample data.
- Execution snapshot: the saved campaign version or calculation generations used for consistent execution. A newer live value does not automatically replace the snapshot of work already running. See data freshness.
Automation and personalization
- Workflow: a journey made of triggers, actions, conditions and waits. Publishing saves the version that new runs use; existing runs retain their version. See workflows.
- Run: one execution through a workflow. A split or qualifying later event can create another run with its own history. See workflow runs.
- Liquid: deterministic insertion, formatting, conditions and loops over supplied data. It does not require a writing-model call. See Liquid.
- Adaptyle: authored instructions that generate selected email passages. Liquid resolves first; the model runs only when prompts remain for that recipient. Fixed content is checked against the reference. See Adaptyle.
- maxinja: the in-app assistant your team briefs to investigate and build saved work. Draft authoring, background workflows and recipient personalization are separate actions. See maxinja.
- Runtime AI settings: the model and thinking depth an email or AI workflow step uses when it executes. They are separate from the assistant conversation's model. See workflow AI.
- Trait Threshold: a workflow trigger for a published computed value crossing a typed condition. Publishing its baseline does not immediately trigger the whole already-matching population. See workflow blocks.
Sending and compliance
- Domain: a sender domain verified using the DNS records maxclicks supplies. Verification and the account's ability to send are separate checks. See domain setup.
- Marketing subscription: permission recorded for email marketing. A communication topic adds a more specific subscription requirement when the email selects that topic. See email types.
- Suppression: a sending restriction associated with an address. Marketing and transactional sends apply different suppression rules; transactional status does not bypass delivery-failure suppression. See contacts.
- Test send: a real transactional message containing the editor's rendered sample. It uses sending allowance but does not validate the production audience or marketing recipient mapping. See email preview and tests.
Read the state before taking another action
| Term | What it establishes |
|---|---|
| Accepted event | maxclicks has durably accepted the occurrence; check its readiness before assuming downstream availability. |
| Ready event | The event has reached the readiness state used by downstream consumers. |
| Scheduled broadcast | A delivery time is set. Preparation can begin before that time and close editing. |
| Ready to send in the editor | The draft's current readiness checks pass. Campaign preparation and actual execution have further checks. |
| Paused workflow | New execution and existing runs wait; completed effects remain. |
| Stopped broadcast | Remaining work is cancelled. It cannot be resumed as the same send. |
| Sent | The email provider accepted the message. |
| Delivered | A later provider delivery event was received; this does not establish inbox placement or a human read. |
| Unknown outcome | Acceptance of an external action could not be confirmed. Inspect and reconcile before creating another action. |
Working with developers and billing
- Public API: the documented endpoints for integrating your product with maxclicks. App functionality and available SDK methods can have different coverage. See API reference.
- API key: a secret credential for a workspace and its permissions. An attribute's API key label refers to its field identifier, not this authentication secret. See authentication.
- Idempotency key: a reference reused for retries of one supported API operation. A new key represents a different operation; source event deduplication uses its own event identifier. See idempotency.
- Webhook: a delivery from maxclicks to your endpoint, or an incoming trigger endpoint for a workflow. Outgoing deliveries can retry, so the receiver should deduplicate them. See webhooks.
- Credits: units charged for applicable application work and AI usage. Recipient rendering, corrections and campaign reviews can add usage beyond writing the initial draft. See billing.
- Wallet and seat allowance: the workspace balance funds background work; eligible member activity can use that member's available allowance first. Seats do not pool their personal allowances. See billing.
Next
Start with the data model, or use the guides for a specific customer task.
The maxclicks data model