Overview
Developer
The developer-facing parts of ContextWorks: what you can call, what you can implement, and what comes back.
| Page | Covers |
|---|---|
| Apex API | Entity.load, find, loadMany, write, create — calling the engine |
| Provider SPI | EntityEnrichmentProvider, EnrichmentItem — extending it |
| Invocable actions | The eight runtime actions and every input, plus the seven administration actions in summary |
| JSON payload schema | Key by key, for parsing |
| Query filters | Filter syntax, operators, date literals |
Namespace
The package namespace is ctxl. Reference package classes from your own code as ctxl.ClassName:
String context = ctxl.Entity.load(recordId);Examples in this section include the prefix. Inside the package, drop it.
API stability
The classes and methods documented here are global. Once the first released package version installs anywhere, they freeze: a global member can be deprecated, never removed or changed. Two caveats while the package is pre-1.0:
- The JSON payload schema carries
schemaVersion0.1-beta. It becomes additive-only once stable, so read that key if you parse payloads in production. - The global surface is provisional until the freeze review before the first released version. Beta versions may still change it.
Anything not documented here is internal and may change without notice.
What’s callable from where
| From | Use |
|---|---|
| Apex | Entity directly |
| Flow, Prompt Builder | The invocable actions, or your own invocable over Entity |
| Agentforce | Agent actions over the invocables |
| MCP | Tools over the invocables |
| Another package | ctxl.Entity — the global classes are the contract |