Campaign Start

Overview

The Campaign Start node decides when a campaign flow is allowed to run. It does not receive input from other nodes in the normal flow path.

How it triggers depends on campaign type:

• CX Voice campaigns — triggered externally by Governor when dial capacity is available. The node waits for those HTTP triggers; it does not run on its own timer.

• Non-CX Voice campaigns — self-triggers on a timer using the campaign’s Trigger Interval, checking publish status and schedule each time.

In both cases, the node only sends a pulse when the campaign is Published and (for Non-CX Voice) within the configured schedule.

Category

Configuration Options

Campaign Start has almost no settings in the flow editor. Most behavior is controlled in Unified Admin → Campaign settings.

Campaign Start configuration notes

• Schedule fields are edited in Unified Admin, not on the node itself.

• For CX Voice, Trigger Interval is disabled in Unified Admin — timing is handled by Governor.

• For Non-CX Voice, Trigger Interval must be a positive number (minimum 1 second).

• If Time Window, Days, or Date Range are set on the campaign, all enabled checks must pass for a pulse to be sent (Non-CX Voice path).

• If the campaign type is not set yet, the node retries using the campaign’s Trigger Interval until the type is available.

When Does It Trigger?

Non-CX Voice campaigns (self-triggered)

Every time the Trigger Interval elapses, the node:

1. Loads the latest campaign from the campaigns backend

2. Checks the campaign is Published

3. Checks the current date/time against the campaign schedule (time window, days, date range — whichever are configured)

4. If all checks pass, sends one message to start the flow

If any check fails, the node stays quiet and tries again on the next interval.

The node also re-reads the campaign on each tick, so changes to schedule or trigger interval in Unified Admin are picked up without redeploying the flow.

CX Voice campaigns (Governor-triggered)

For CX Voice, the node does not run on its own timer. Instead:

1. Governor (in the campaigns backend) runs on a schedule and decides how many dial slots each active CX Voice campaign should receive

2. Governor calls POST /red/campaign-trigger/:flowId with slot and contact information

3. Campaign Start receives that trigger, syncs the dial budget, and sends a pulse into the flow

Governor only triggers campaigns that are Published, CX Voice, and within their schedule.

If Governor assigns 0 dial slots (no capacity or nothing to dial), Campaign Start updates its status but does not send a flow pulse.

Node status indicators

Output

When the node fires, it sends a single message shaped like this.

Non-CX Voice (no Governor slots)

{
  "payload": {},
  "id": "<auto-generated message id>",
  "outboundMetadata": {},
  "timezoneComplianceMetadata": {
    "checkCompliance": false,
    "useTimeWindow": true,
    "startTime": "09:00",
    "endTime": "17:00",
    "useDays": true,
    "days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
    "useStartEndDate": false,
    "startDate": "",
    "endDate": "",
    "timezone": "Asia/Karachi"
  }
}

CX Voice (Governor trigger with allocated slots)

{
  "payload": {},
  "id": "<auto-generated message id>",
  "outboundMetadata": {
    "allocatedSlots": 5,
    "slotsRemaining": 5
  },
  "timezoneComplianceMetadata": {
    "checkCompliance": false,
    "useTimeWindow": true,
    "startTime": "09:00",
    "endTime": "17:00",
    "useDays": true,
    "days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
    "useStartEndDate": false,
    "startDate": "",
    "endDate": "",
    "timezone": "Asia/Karachi"
  }
}