Journeys Tools

Tools for multi-step journeys: creating them, enrolling people, and reviewing runs.

10 tools

Available Tools

journeys_templates

Starter journeys (welcome series, abandoned cart, appointment reminder, win-back) as full documents to adapt. Each lists the site events it needs.

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "journeys_templates",
    "arguments": {}
  }
}

journeys_list

Journeys of a site with their status (draft/live/paused/stopped), trigger, step count and run counts.

Input Schema

projectId

stringrequired

Site id

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "journeys_list",
    "arguments": {
          "projectId": "example"
    }
  }
}

journeys_get

One journey with its full document and stats (runs by status, emails sent, opened, clicked).

Input Schema

id stringrequired

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "journeys_get",
    "arguments": {
          "id": "example"
    }
  }
}

journeys_create

Create a journey for a site. It starts as a draft unless status=live.

Input Schema

`projectId`	stringrequired	Site id
`name`	stringrequired
`description`	string
`document`	any	A full journey document (see journeys_templates for the shape)
`template`	string	Starter key from journeys_templates (welcome-series, abandoned-cart, appointment-reminder, win-back)
`status`	string	draft (default) or live

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "journeys_create",
    "arguments": {
          "projectId": "example",
          "name": "example",
          "description": "example"
    }
  }
}

journeys_update

Rename, describe, or replace the document (version bumps; people already inside follow the new steps from where they are).

Input Schema

`id`	stringrequired
`name`	string
`description`	string
`document`	any	Replaces the whole document; the version bumps and in-flight runs follow the new steps from where they are

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "journeys_update",
    "arguments": {
          "id": "example",
          "name": "example",
          "description": "example"
    }
  }
}

journeys_setStatus

live = enrols and sends; paused = no new entries, people already inside finish; stopped = halts everyone now; draft = editing

Input Schema

`id`	stringrequired
`status`	stringrequired

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "journeys_setStatus",
    "arguments": {
          "id": "example",
          "status": "example"
    }
  }
}

journeys_delete

Delete a journey (stops every run first).

Input Schema

id stringrequired

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "journeys_delete",
    "arguments": {
          "id": "example"
    }
  }
}

journeys_runs

People in a journey: status, current step, next send time, exit reason.

Input Schema

`journeyId`	stringrequired
`status`	string
`limit`	integer

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "journeys_runs",
    "arguments": {
          "journeyId": "example",
          "status": "example",
          "limit": {}
    }
  }
}

journeys_run

One run with its step log and the emails it sent.

Input Schema

id stringrequired

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "journeys_run",
    "arguments": {
          "id": "example"
    }
  }
}

journeys_enrol

Put one person into a live journey by hand (also how a function or agent starts a `manual` journey).

Input Schema

`journeyId`	stringrequired
`subjectId`	string	Site member id
`email`	string
`properties`	object

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "journeys_enrol",
    "arguments": {
          "journeyId": "example",
          "subjectId": "example",
          "email": "example"
    }
  }
}