# Start Workflow — Wealthbox

> Enroll a contact in a workflow template via POST /workflows. Run List Workflow Templates to find the template id and List Contact Options to find the contact id to enroll. Example: enroll contact 67890 in template 999 starting…

- Key: `wealthbox-start-workflow`
- Type: Action (Write)
- Version: 0.0.2
- App: Wealthbox (`wealthbox`) — https://pipedream.com/apps/wealthbox.md
- This page (HTML): https://pipedream.com/apps/wealthbox/actions/start-workflow
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/wealthbox/actions/start-workflow/start-workflow.mjs

## Description

Enroll a contact in a workflow template via POST /workflows. Run **List Workflow Templates** to find the template id and **List Contact Options** to find the contact id to enroll. Example: enroll contact `67890` in template `999` starting `2026-09-01T09:00:00Z`; returns the workflow enrollment object including `id`, `workflow_template`, `linked_to`, and `starts_at`. [See the documentation](https://dev.wealthbox.com/#workflows-retrieve-all-workflows-post)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `workflowId` | `string` | Yes | Free-form id of the workflow template to enroll into (sent as workflow_template). Run List Workflow Templates first. Example: 999. |
| `linkedToId` | `string` | Yes | Free-form id of the contact to enroll (sent as linked_to.id). Run List Contact Options first. Example: 67890. |
| `linkedToType` | `string` | No | Type of the linked resource (sent as linked_to.type). Defaults to Contact. |
| `label` | `string` | No | Optional label for the workflow enrollment. |
| `startsAt` | `string` | No | Optional ISO 8601 datetime for when the workflow should start. Example: 2019-02-25 03:00 PM -0400. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "wealthbox",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "wealthbox-start-workflow",
  arguments: {
    workflowId: "Workflow Template ID",
    linkedToId: "Contact ID",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "wealthbox-start-workflow",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    wealthbox: { authProvisionId: "apn_xxxxxxx" },
    workflowId: "Workflow Template ID",
    linkedToId: "Contact ID",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "wealthbox-start-workflow",
    "configured_props": {
      "wealthbox": { "authProvisionId": "apn_xxxxxxx" },
      "workflowId": "Workflow Template ID",
      "linkedToId": "Contact ID"
    }
  }'
```

---

- App: https://pipedream.com/apps/wealthbox.md · All apps: https://pipedream.com/apps