Headlessly

Entities

All 35 core entities across 11 product domains.

Every entity exists because headless.ly needs it to run itself as an autonomous business.

Base Meta-Fields

Every Digital Object carries these $ meta-fields automatically — you never declare them in a Noun, but they're always present:

{
  $type: 'Contact',                              // TypeScript discriminator
  $id: 'contact_fX9bL5nRd',                     // unique, type-prefixed
  $context: 'https://headless.ly/~acme',         // tenant namespace
  $version: 7,                                   // event-sourcing version
  $createdAt: '2025-01-15T...',
  $createdBy: 'user_Qm8xNfKpL',
  $updatedAt: '2025-02-07T...',
}

$context supports custom domains — if Acme maps api.acme.com to their org, then https://headless.ly/~acme and https://api.acme.com resolve to the same data.

Domains

DomainPackageEntitiesCount
Identity@headlessly/sdkUser, ApiKey2
CRM@headlessly/crmOrganization, Contact, Lead, Deal, Activity, Pipeline6
Billing@headlessly/billingCustomer, Product, Plan, Price, Subscription, Invoice, Payment7
Projects@headlessly/projectsProject, Issue, Comment3
Content@headlessly/contentContent, Asset, Site3
Support@headlessly/supportTicket1
Analytics@headlessly/analyticsEvent, Metric, Funnel, Goal4
Marketing@headlessly/marketingCampaign, Segment, Form3
Experimentation@headlessly/experimentsExperiment, FeatureFlag2
Platform@headlessly/platformWorkflow, Integration, Agent3
Communication@headlessly/sdkMessage1

All entities share the same interface: create, get, find, update, delete, count, plus custom verbs defined on each Noun.

All 35 Entities

The complete entity reference, alphabetical. Every entity supports CRUD automatically. Custom verbs add domain-specific lifecycle.

#EntityDomainCustom Verbs
1ActivityCRMcomplete, cancel, log
2AgentPlatformdeploy, pause, retire, invoke
3ApiKeyIdentityrevoke
4AssetContentprocess
5CampaignMarketinglaunch, pause, complete
6CommentProjectsresolve
7ContactCRMqualify, capture, assign, merge, enrich
8ContentContentpublish, archive, schedule
9CustomerBilling
10DealCRMclose, win, lose, advance, reopen
11EventAnalytics
12ExperimentExperimentationstart, conclude, pause, stop
13FeatureFlagExperimentationrollout, enable, disable
14FormMarketingpublish, archive, submit
15FunnelAnalyticsactivate
16GoalAnalyticsachieve, complete, miss, reset
17IntegrationPlatformconnect, disconnect, sync
18InvoiceBillingpay, void, finalize
19IssueProjectsassign, close, reopen
20LeadCRMconvert, lose
21MessageCommunicationsend, deliver, read
22MetricAnalyticssnapshot, record, reset
23OrganizationCRMenrich, score
24PaymentBillingrefund, capture
25PipelineCRM
26PlanBilling
27PriceBilling
28ProductBilling
29ProjectProjectsarchive, complete, activate
30SegmentMarketingrefresh
31SiteContent
32SubscriptionBillingpause, cancel, reactivate, upgrade, downgrade, activate, renew
33TicketSupportresolve, escalate, close, reopen
34UserIdentityinvite, suspend, activate
35WorkflowPlatformactivate, pause, trigger, archive

On this page