View as Markdown
Rejoiner icon

Rejoiner ACTION

Start Journey

Triggers the beginning of a customer journey in Rejoiner. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Rejoiner account once, then configure and run Start Journey from your backend or agent.

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: "rejoiner-start-journey",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    rejoiner: { authProvisionId: "apn_xxxxxxx" },
    webhookUrl: "Webhook Endpoint URL",
    email: "Email",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Start Journey inputs
Property Type Description
webhookUrl Webhook Endpoint URL string
Webhook URL of the journey. A webhook-triggered journey will provide an explicit Webhook Endpoint URL to be used for triggering the journey
Required
email Email string
The email address of the customer
Required
metadata Metadata object
Metadata to be attached to the customer's journey session metadata
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
rejoiner-start-journey
Version
0.0.2
App
Rejoiner
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes