Get journey blueprint

Read one journey blueprint with its steps, the placeholder starterTemplate every created step template starts from, and a preview journey definition built with default timings (send templateRefs are starter:<step> placeholders and topicKey is topic-key).

Outcome

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.journey_blueprints.get --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.journey_blueprints.list --detail --json

id: Journey blueprint id from the blueprint catalog.

Request

GET /api/journey-blueprints/{id}

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

Field	Required	Type	Constraints
`id`	Required	string	Journey blueprint id from the blueprint catalog. {"enum":["welcome_series","trial_onboarding_14d","re_engagement","win_back","not_now_90d"]}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "enum": [
        "welcome_series",
        "trial_onboarding_14d",
        "re_engagement",
        "win_back",
        "not_now_90d"
      ]
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

Reads one blueprint without changing state.

Interpret the response

The returned identifier path is $.blueprint.id for journey_blueprint. Empty lists do not discover a target.

Confirm $.blueprint.id equals the requested id.

Exact success schema:

{
  "type": "object",
  "required": [
    "blueprint"
  ],
  "properties": {
    "blueprint": {
      "type": "object",
      "required": [
        "id",
        "name",
        "sendSteps",
        "delaySteps"
      ],
      "properties": {
        "id": {
          "type": "string",
          "enum": [
            "welcome_series",
            "trial_onboarding_14d",
            "re_engagement",
            "win_back",
            "not_now_90d"
          ]
        },
        "name": {
          "type": "string"
        },
        "summary": {
          "type": "string"
        },
        "entry": {
          "type": "string",
          "enum": [
            "event",
            "segment"
          ]
        },
        "triggerEventTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "goalEventType": {
          "type": "string"
        },
        "defaultPurpose": {
          "type": "string"
        },
        "sendSteps": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "label"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "label": {
                "type": "string"
              }
            }
          }
        },
        "delaySteps": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "defaultMinutes"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "defaultMinutes": {
                "type": "integer"
              }
            }
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "starterTemplate": {
          "type": "object"
        },
        "preview": {
          "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:

{
  "id": "welcome_series"
}

CLI:

topolo actions validate app_topolo_nurture.journey_blueprints.get --data @payload.json --json
topolo actions plan app_topolo_nurture.journey_blueprints.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.journey_blueprints.get --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.journey_blueprints.get",
    "input": {
      "id": "welcome_series"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "blueprint": {
    "id": "welcome_series",
    "name": "Welcome series",
    "summary": "Three emails over five days after signup; a purchase ends the journey as converted.",
    "entry": "event",
    "triggerEventTypes": [
      "signup"
    ],
    "goalEventType": "purchase",
    "defaultPurpose": "marketing",
    "sendSteps": [
      {
        "id": "email_1",
        "label": "Email 1 (day 0)"
      },
      {
        "id": "email_2",
        "label": "Email 2 (day 2)"
      },
      {
        "id": "email_3",
        "label": "Email 3 (day 5)"
      }
    ],
    "delaySteps": [
      {
        "id": "wait_1",
        "defaultMinutes": 2880
      },
      {
        "id": "wait_2",
        "defaultMinutes": 4320
      }
    ],
    "notes": [],
    "starterTemplate": {
      "subject": "[Subject]",
      "blocks": [
        {
          "id": "heading",
          "kind": "heading",
          "level": 1,
          "text": "[Heading]"
        },
        {
          "id": "body",
          "kind": "text",
          "text": "[Write your message here]"
        },
        {
          "id": "footer",
          "kind": "footer"
        }
      ]
    },
    "preview": {
      "trigger": {
        "eventTypes": [
          "signup"
        ],
        "segmentIds": []
      },
      "entryNodeId": "email_1",
      "nodes": [
        {
          "id": "email_1",
          "kind": "send",
          "templateRef": "starter:email_1",
          "purpose": "marketing",
          "topicKey": "topic-key",
          "next": "wait_1"
        },
        {
          "id": "wait_1",
          "kind": "delay",
          "delay": {
            "mode": "duration",
            "minutes": 2880
          },
          "next": "email_2"
        },
        {
          "id": "email_2",
          "kind": "send",
          "templateRef": "starter:email_2",
          "purpose": "marketing",
          "topicKey": "topic-key",
          "next": "wait_2"
        },
        {
          "id": "wait_2",
          "kind": "delay",
          "delay": {
            "mode": "duration",
            "minutes": 4320
          },
          "next": "email_3"
        },
        {
          "id": "email_3",
          "kind": "send",
          "templateRef": "starter:email_3",
          "purpose": "marketing",
          "topicKey": "topic-key",
          "next": "done"
        },
        {
          "id": "goal",
          "kind": "goal",
          "eventType": "purchase"
        },
        {
          "id": "done",
          "kind": "exit"
        }
      ]
    }
  }
}

HTTP 200. Confirm $.blueprint.id equals the requested id.

Another supported request

Input · payload.json:

{
  "id": "not_now_90d"
}

CLI:

topolo actions validate app_topolo_nurture.journey_blueprints.get --data @payload.json --json
topolo actions plan app_topolo_nurture.journey_blueprints.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.journey_blueprints.get --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.journey_blueprints.get",
    "input": {
      "id": "not_now_90d"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "blueprint": {
    "id": "not_now_90d",
    "name": "90-day \"not now\" nurture",
    "summary": "Three emails at days 30, 60 and 90 after a prospect answers \"not now\" to outreach; a signup converts.",
    "entry": "event",
    "triggerEventTypes": [
      "engage_not_now"
    ],
    "goalEventType": "signup",
    "defaultPurpose": "outreach",
    "sendSteps": [
      {
        "id": "email_30d",
        "label": "Check-in (day 30)"
      },
      {
        "id": "email_60d",
        "label": "Check-in (day 60)"
      },
      {
        "id": "email_90d",
        "label": "Check-in (day 90)"
      }
    ],
    "delaySteps": [
      {
        "id": "wait_30d",
        "defaultMinutes": 43200
      },
      {
        "id": "wait_60d",
        "defaultMinutes": 43200
      },
      {
        "id": "wait_90d",
        "defaultMinutes": 43200
      }
    ],
    "notes": [
      "Enrolls on the engage_not_now lifecycle event (source engage) ingested through events.ingest. TopoloEngage does not yet publish a \"not now\" event or action that delivers it automatically; until it does, send the event when an Engage thread is classified not_now."
    ],
    "starterTemplate": {
      "subject": "[Subject]",
      "blocks": [
        {
          "id": "heading",
          "kind": "heading",
          "level": 1,
          "text": "[Heading]"
        },
        {
          "id": "body",
          "kind": "text",
          "text": "[Write your message here]"
        },
        {
          "id": "footer",
          "kind": "footer"
        }
      ]
    },
    "preview": {
      "trigger": {
        "eventTypes": [
          "engage_not_now"
        ],
        "segmentIds": []
      },
      "entryNodeId": "wait_30d",
      "nodes": [
        {
          "id": "wait_30d",
          "kind": "delay",
          "delay": {
            "mode": "duration",
            "minutes": 43200
          },
          "next": "email_30d"
        },
        {
          "id": "email_30d",
          "kind": "send",
          "templateRef": "starter:email_30d",
          "purpose": "outreach",
          "topicKey": "topic-key",
          "next": "wait_60d"
        },
        {
          "id": "wait_60d",
          "kind": "delay",
          "delay": {
            "mode": "duration",
            "minutes": 43200
          },
          "next": "email_60d"
        },
        {
          "id": "email_60d",
          "kind": "send",
          "templateRef": "starter:email_60d",
          "purpose": "outreach",
          "topicKey": "topic-key",
          "next": "wait_90d"
        },
        {
          "id": "wait_90d",
          "kind": "delay",
          "delay": {
            "mode": "duration",
            "minutes": 43200
          },
          "next": "email_90d"
        },
        {
          "id": "email_90d",
          "kind": "send",
          "templateRef": "starter:email_90d",
          "purpose": "outreach",
          "topicKey": "topic-key",
          "next": "done"
        },
        {
          "id": "goal",
          "kind": "goal",
          "eventType": "signup"
        },
        {
          "id": "done",
          "kind": "exit"
        }
      ]
    }
  }
}

HTTP 200. Confirm $.blueprint.id equals the requested id.

Refused request · invalid_input

Input · payload.json:

{
  "id": "unknown"
}

CLI:

topolo actions validate app_topolo_nurture.journey_blueprints.get --data @payload.json --json
topolo actions plan app_topolo_nurture.journey_blueprints.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 422:

{
  "error": {
    "code": "invalid_input",
    "message": "The input does not match the action schema.",
    "details": [
      {
        "code": "invalid_value",
        "values": [
          "welcome_series",
          "trial_onboarding_14d",
          "re_engagement",
          "win_back",
          "not_now_90d"
        ],
        "path": [
          "id"
        ],
        "message": "Invalid option: expected one of \"welcome_series\"|\"trial_onboarding_14d\"|\"re_engagement\"|\"win_back\"|\"not_now_90d\""
      }
    ]
  }
}

HTTP 422. Preserve the refusal details and do not claim success.

Verify the result

Confirm $.blueprint.id equals the requested id.

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.
invalid_input (HTTP 422): Use an id from app_topolo_nurture.journey_blueprints.list.

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.

Create journey from blueprint: Create a DRAFT journey from a blueprint. Pass requestKey (a retry with the same key returns the same draft and templates, replayed true), topicKey (an active subscription topic), optional name, purpose (marketing or outreach), segmentId (required for win_back, where entering it enrolls; otherwise an audience filter), delays {delayStepId: minutes} and templateIds {sendStepId: templateId}. Send steps without a template id need createStarterTemplates true: each gets a new template holding only bracketed placeholders ([Subject], [Heading], [Write your message here]) for a person to replace. Nothing is published, enrolled or sent; publish with app_topolo_nurture.journeys.publish after editing.

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.

Get journey blueprint

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Refused request · invalid_input

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence