Outcome
List every typed lifecycle event Nurture records (signup, trial_started, trial_ending, form_submitted, purchase, subscription_changed, feature_used, the derived inactive and mql, engage_not_now) with its property JSON Schema, whether it can be ingested, and how its contact resolves (contactId, then email, then externalId).
Before you start
- Verify identity and pin the intended organization and environment before discovering the action.
- Discover a granted Nurture workspace. The application permission is workspace:read; required workspace access is read. A permission alone does not supply a workspace grant.
- Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.
Discover the target
topolo whoami --json
topolo actions get app_topolo_nurture.events.catalog --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
Request
GET /api/events/catalog
Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.
Inspect and test this action in the signed action console. A test response still requires the verification below.
Input fields
Use an empty JSON object; verified credential and resource context are separate.
Exact input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}
Effects
- Reads the static catalog without changing state.
Interpret the response
The returned identifier path is $.eventTypes[].type for lifecycle_event_type. Empty lists do not discover a target.
Confirm $.version is present and the eventType you plan to ingest has ingestable true.
Exact success schema:
{
"type": "object",
"required": [
"version",
"eventTypes"
],
"properties": {
"version": {
"type": "string"
},
"eventTypes": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"ingestable",
"propertiesSchema"
],
"properties": {
"type": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"derived": {
"type": "boolean"
},
"ingestable": {
"type": "boolean"
},
"contactResolution": {
"type": "array",
"items": {
"type": "string"
}
},
"propertiesSchema": {
"type": "object"
}
}
}
}
}
}
Worked examples
Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.
Successful request
Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.
Input · payload.json:
{}
CLI:
topolo actions validate app_topolo_nurture.events.catalog --data @payload.json --json
topolo actions plan app_topolo_nurture.events.catalog --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.events.catalog --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
MCP tool and arguments:
{
"tool": "topolo_read_action",
"arguments": {
"actionId": "app_topolo_nurture.events.catalog",
"input": {},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>"
}
}
Captured local response · HTTP 200:
{
"version": "2026-10-02",
"eventTypes": [
{
"type": "signup",
"label": "Signup",
"description": "A person created an account or registered.",
"derived": false,
"ingestable": true,
"contactResolution": [
"contactId",
"email",
"externalId"
],
"propertiesSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"plan": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"method": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"userId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 120
},
{
"type": "null"
}
]
}
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
{
"type": "trial_started",
"label": "Trial started",
"description": "A trial of a plan began.",
"derived": false,
"ingestable": true,
"contactResolution": [
"contactId",
"email",
"externalId"
],
"propertiesSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"planId": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"trialEndsAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
{
"type": "trial_ending",
"label": "Trial ending",
"description": "A trial is about to end.",
"derived": false,
"ingestable": true,
"contactResolution": [
"contactId",
"email",
"externalId"
],
"propertiesSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"planId": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"subscriptionId": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"trialEndsAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
{
"type": "form_submitted",
"label": "Form submitted",
"description": "A person submitted a form.",
"derived": false,
"ingestable": true,
"contactResolution": [
"contactId",
"email",
"externalId"
],
"propertiesSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"formId": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"submissionId": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"required": [
"formId"
],
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
{
"type": "purchase",
"label": "Purchase",
"description": "A payment or order completed.",
"derived": false,
"ingestable": true,
"contactResolution": [
"contactId",
"email",
"externalId"
],
"propertiesSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"orderId": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"planId": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"subscriptionId": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"required": [
"amountMinor",
"currency"
],
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
{
"type": "subscription_changed",
"label": "Subscription changed",
"description": "A subscription was renewed, upgraded, downgraded, cancelled, reactivated or its trial ended.",
"derived": false,
"ingestable": true,
"contactResolution": [
"contactId",
"email",
"externalId"
],
"propertiesSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"change": {
"type": "string",
"enum": [
"started",
"renewed",
"upgraded",
"downgraded",
"cancel_requested",
"cancelled",
"reactivated",
"trial_ended"
]
},
"planId": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"subscriptionId": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"required": [
"change"
],
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
{
"type": "feature_used",
"label": "Feature used",
"description": "A person used a product feature (app usage).",
"derived": false,
"ingestable": true,
"contactResolution": [
"contactId",
"email",
"externalId"
],
"propertiesSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"feature": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"feature"
],
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
{
"type": "inactive",
"label": "Inactive",
"description": "Derived by Nurture: the contact has had no lifecycle activity for the workspace inactivity window.",
"derived": true,
"ingestable": false,
"contactResolution": [
"contactId",
"email",
"externalId"
],
"propertiesSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"inactiveDays": {
"type": "integer",
"minimum": 1,
"maximum": 365
},
"lastActivityAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"inactiveDays",
"lastActivityAt"
],
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
{
"type": "mql",
"label": "Marketing qualified lead",
"description": "Derived by Nurture: lead scoring recorded the first time the contact reached the published MQL threshold.",
"derived": true,
"ingestable": false,
"contactResolution": [
"contactId",
"email",
"externalId"
],
"propertiesSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"score": {
"type": "number"
},
"threshold": {
"type": "number"
},
"modelVersion": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"score",
"threshold",
"modelVersion"
],
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
{
"type": "engage_not_now",
"label": "Engage: not now",
"description": "TopoloEngage classified a reply as \"not now\". Never creates a contact or subscription; Nurture consent and eligibility still apply.",
"derived": false,
"ingestable": true,
"contactResolution": [
"contactId",
"email",
"externalId"
],
"propertiesSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"threadId": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"campaignId": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"trigger": {
"type": "string",
"enum": [
"classify",
"handoff"
]
},
"followUpOn": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
}
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
}
]
}
HTTP 200. Confirm $.version is present and the eventType you plan to ingest has ingestable true.
Refused request · permission_denied
Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.
Input · payload.json:
{}
CLI:
topolo actions validate app_topolo_nurture.events.catalog --data @payload.json --json
topolo actions plan app_topolo_nurture.events.catalog --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
Captured local response · HTTP 403:
{
"error": {
"code": "permission_denied",
"message": "The credential lacks workspace:read.",
"details": {
"requiredPermission": "workspace:read"
}
}
}
HTTP 403. Preserve the refusal details and do not claim success.
Verify the result
- Confirm $.version is present and the eventType you plan to ingest has ingestable true.
Errors and recovery
organization_required(HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.permission_denied(HTTP 403): Grant the credential the required Nurture workspace permission.workspace_required(HTTP 409): Create a Nurture workspace, or pass the workspace resource context.invalid_input(HTTP 422): Correct the fields named in error.details using inputSchema, then retry.
Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.
Recovery boundary
This action does not change service state.
Related actions
- Ingest lifecycle events: Record one typed lifecycle event, or a batch of up to 100 as {events: [...]}, from app usage or any system. Each event is validated against events.catalog, names its contact by contactId, email or externalId (email is used to resolve, never stored; no contact or subscription is created), and is stored once per idempotency key. New events run journey triggers and goals, then rescore the contact against the published lead scoring model. Derived types (inactive, mql) are reserved: 422 reserved_event_type.
- List Notify source adapters: List the fixed, versioned adapters from TopoloNotify event types (published @topolo-io/notifications taxonomy) to Nurture lifecycle event types for Auth, Forms, Pay, Commerce and Engage, plus Nexus nexus.email.* delivery events (lifecycleEventType nexus_email_delivery: applied to the matching send as delivery engagement and suppressions, not ingested as lifecycle events). Available entries can be connected; unavailable entries name the missing published contract and the events.ingest fallback.
Evidence
Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.