Back to docs

2026-02-16

Tag Lifecycle and Configuration Reference

Reference for status transitions, field definitions, and safe mutation patterns across Direct and Hyper tags.

docsreferencelifecycleconfiguration
Hypertag cover image

Tag Lifecycle and Configuration Reference

Lifecycle states

Hypertag tags move through three operational states:

  • `Draft`: editable configuration before production use
  • `Active`: live behavior enabled for scans
  • `Inactive`: temporarily disabled from active operation

Expected transition pattern:

Draft -> Active -> Inactive

Common fields

All tags include:

  • `name`
  • `description` (optional)
  • `type` (`Direct` | `Hyper`)
  • `status`
  • `createdAt`
  • `userId` (optional, ownership)

Type-specific fields

Direct tags:

  • `link` (destination URL)

Hyper tags:

  • `webhook` (target endpoint)
  • `payload` (optional JSON object/string)

Activation and deactivation behavior

Activation:

  • Sets `status` to `Active`
  • Persists configuration updates in the same mutation where provided

Deactivation:

  • Sets `status` to `Inactive`
  • May include final config edits before disabling runtime usage

Ownership and update permissions

Typical permission model:

  • Authenticated users can create/read eligible tag documents.
  • Only document owner (`userId == request.auth.uid`) can update/delete.

Use rules that align with your tenant and role model before broader rollout.

Recommended guardrails

  • Validate URLs before saving.
  • Validate Hyper payload JSON before activation.
  • Keep status transitions explicit and auditable.
  • Avoid ad hoc field writes outside defined lifecycle operations.