Scripts

The Scripts feature lets you embed custom JavaScript directly into your campaign flows in the Campaign Builder. Use scripts to call external HTTP APIs, apply business logic, and write data back to session variables that other nodes in the flow can consume.

What scripts can do

Access the current customer’s phone number and session variables as input
Fetch any external HTTP API and parse the response
Return structured output data and an outcome string
Map output fields to session variables for use in downstream nodes

Script structure

Every script exports a single onExecute function:

// name=SCRIPT_NODE1
export async function onExecute(input, config) {
  console.log('hello from script node!');

  const resp = await fetch('https://jsonplaceholder.typicode.com/users/1');
  const body = await resp.json();

  // return [data, outcome]
  return [{ FIELD1: 'one', FIELD2: 42, userName: body.name }, 'OUTCOME2'];
}

Parameters

`input`

Contains the current session context and output from previous script nodes:

{
  "sessionContext": {
    "business": { "id": "..." },
    "customer": { "phoneNumber": "..." },
    "variables": { "VAR1": "1" }
  },
  "SCRIPT_NODE1": {
    "outcome": "...",
    "data": { "FIELD1": "one" }
  }
}

Field	Description
`sessionContext.business.id`	Your Connectly business ID.
`sessionContext.customer.phoneNumber`	The current customer’s phone number.
`sessionContext.variables`	All session variables set so far in the flow.
`SCRIPT_NODE1.outcome`	The outcome returned by a previous script node named `SCRIPT_NODE1`.
`SCRIPT_NODE1.data`	The data object returned by a previous script node.

`config`

Contains secrets configured for the script node:

{
  "secrets": { "SECRET1": "value" }
}

Return value

Scripts must return a tuple [data, outcome]:

return [{ FIELD1: 'one', FIELD2: 42 }, 'OUTCOME2']

Return value	Type	Description
`data`	object	JSON object — any fields you want to save to session variables.
`outcome`	string	A string that maps to an outgoing edge in the flow. Each possible outcome must be configured as an edge in the Campaign Builder. There is no default or fallback outcome.

Mapping output to session variables

After a script node runs, you can map its output fields to session variables for use by downstream nodes:

Raw param	Maps to session variable
`outcome`	Any variable you configure (e.g. `VARX`)
`data`	Any variable (receives the whole data object)
`data.FOO.1`	A specific nested field (e.g. `VAR_FOO1`)

Get Started

Campaigns

Messaging

Webhooks

Assets

AI Features

Analytics

Business Management

Integrations

Resources

What scripts can do

Script structure

Parameters

`input`

`config`

Return value

Mapping output to session variables

​What scripts can do

​Script structure

​Parameters

​input

​config

​Return value

​Mapping output to session variables

What scripts can do

Script structure

Parameters

`input`

`config`

Return value

Mapping output to session variables