Перейти к содержанию

Point reference

Этот контент еще не доступен на вашем языке.

Every point carries a point_data object with exactly one nested key, matching the point’s point_type (see the point-type → key mapping). This page documents the structure under each key.

Entry points

Anchor link to

A journey needs at least one entry point. All entry points have a single default output.

start_by_segment

Anchor link to

Enters users who match a segment. POINT_TYPE_START_BY_SEGMENT.

FieldTypeDescription
application_codestringApplication code.
filter_codestringSegment/filter code that defines the audience.
repeatSegmentRepeatOptional recurring-entry schedule (see SegmentRepeat).
start_attimestampDo not process before this time (ISO 8601).
is_deactivatedboolWhether this entry point is turned off.

message_bus (event entry)

Anchor link to

Enters users when they trigger an event. POINT_TYPE_EVENT.

FieldTypeDescription
event_namestringEvent name to listen for.
application_codestringApplication code.
event_conditionsPointEventCondition[]Conditions matched against the event’s attributes.
active_periodPeriodTime window during which the trigger is active.
multi_entryMultiEntryHow a user may enter more than once (see MultiEntry).
attribute_entryAttributeEntryEnroll the user IDs carried in an event attribute instead of the user who triggered the event (see AttributeEntry).
allow_reenterboolWhether users may re-enter the journey.
AttributeEntry
Anchor link to

Enrolls the User IDs carried in an event attribute, instead of the user who triggered the event. Mirrors Users from an event attribute in the Customer Journey builder.

FieldTypeDescription
enabledboolWhether to enroll users named in an event attribute rather than the user who triggered the event.
attribute_namestringName of the event attribute that holds the User ID (or list of User IDs) to enroll.

start_by_api

Anchor link to

Entry point fed by the Start by API call. POINT_TYPE_START_BY_API.

FieldTypeDescription
application_codestringApplication code.
attributesstring[]Names of the custom attributes that can be passed in the attribute_values of a Start by API request.
is_deactivatedboolWhether this entry point is turned off.

Timing points

Anchor link to

delay (wait)

Anchor link to

Pauses each user for a fixed or computed interval. POINT_TYPE_WAIT. The point_data.delay object sets exactly one of the following interval keys:

Interval keyTypeDescription
secuint64Wait a fixed number of seconds.
exact_timeExactTimeWait until a time of day (hour, minute).
exact_date_timeExactDateTimeWait until an absolute date and time.
exact_week_days_timeExactWeekDaysTimeWait until specific times on specific weekdays (map of day 0=Monday … 6=Sunday → ExactTime).
dynamic_timeDynamicTimeWait relative to a value from a tag or event.

A dynamic_time with split_branches: true adds an output1 branch (see output keys).

DynamicTime

Anchor link to
FieldTypeDescription
fromenum DynamicTimeFromWhether the base time comes from a tag or an event.
directionenum DynamicTimeDirectionOffset before or after the base time.
durationuint64Size of the offset.
unitenum DynamicTimeUnitUnit of duration (minutes, hours, days, …).
split_branchesboolSplit users into separate branches when their computed times differ.
tag_namestringTag holding the base time (when from is a tag).
event_name / event_attribute / point_idstringEvent source of the base time (when from is an event).

wait_event

Anchor link to

Waits until users trigger an event (or a timeout). POINT_TYPE_WAIT_EVENT. The default output is the not-triggered path. The triggered path is output1 or, with a script, one branch per condition.

FieldTypeDescription
eventsPointWaitEventInfo[]Events to wait for.
conditions_scriptstringOptional script for complex multi-event logic. Its parsed condition names become the output keys.
multi_entryMultiEntryRe-entry behavior.

Splitting and filtering points

Anchor link to

boolean_splitter

Anchor link to

Routes users down branches based on a condition. POINT_TYPE_BOOLEAN_SPLITTER.

FieldTypeDescription
application_codestringApplication code.
split_strategyenumSPLIT_FILTER (by segment), SPLIT_TAGS (by tag conditions), or SPLIT_EVENTS (by event conditions).
load_policyenumALL (any of the user’s devices may match) or FILTER (only the current device).
filter_codestringSegment code, when split_strategy is SPLIT_FILTER.
filter_expressionsFilterExpression[]Tag conditions, when split_strategy is SPLIT_TAGS: one extra output branch per expression.
eventBooleanSplitterEventInfoEvent conditions, when split_strategy is SPLIT_EVENTS: one extra output branch per condition.

ab_splitter

Anchor link to

Randomly splits users into weighted variants. POINT_TYPE_AB_SPLITTER. Output keys are output0, output1, … (one per entry in split, indexed from 0. There is no default).

FieldTypeDescription
splituint32[]Percentage for each branch. Must sum to 100. Index i maps to output key output{i}.
auto_select_winnerboolWhether to automatically pick a winning branch.
winner_strategyenumANY_GOAL or SPECIFIC_GOAL.
goal_uuidstringGoal used to determine the winner (with SPECIFIC_GOAL).
winner_splituint32Winning branch number (1-based, 0 = no winner yet).

Lets only matching users continue (default), routing the rest to output1. POINT_TYPE_FILTER.

FieldTypeDescription
filterenum FilterA predefined check: EMAIL_EXISTS, PUSH_TOKEN_EXISTS, SMS_TOKEN_EXISTS, WHATSAPP_TOKEN_EXISTS, LINE_TOKEN_EXISTS, or CUSTOM.
filter_rawstringCustom filter expression, when filter is CUSTOM.

Action points

Anchor link to

Updates tags on the user. POINT_TYPE_SET_TAGS.

FieldTypeDescription
application_codestringApplication code.
tagsTag[]Tags to write.
FieldTypeDescription
namestringTag name.
typeenum TagTypeData type and operation: TYPE_STRING, TYPE_INTEGER, TYPE_DATE, TYPE_BOOLEAN, TYPE_LIST, TYPE_LIST_APPEND, TYPE_LIST_REMOVE, TYPE_DYNAMIC, …
valueoneofExactly one value key matching type: str, int, bool, date, price, version, timezone, list, or dynamic.

Sends an outbound HTTP request. POINT_TYPE_WEBHOOK. Single default output.

FieldTypeDescription
methodstringHTTP method (GET, POST, PUT, …).
urlstringTarget URL.
request_templatestringRequest body template. Supports Liquid templating.
headersmap<string, string>HTTP headers.
disabledboolRead-only. true when Pushwoosh auto-disabled the webhook after repeated errors.
reactivateboolWrite-only. Set true to re-enable a disabled webhook.

Conversion points

Anchor link to

goal_event

Anchor link to

Tracks a conversion goal. POINT_TYPE_GOAL_EVENT. Has no outputs.

FieldTypeDescription
event_namestringGoal event name.
application_codestringApplication code.
event_conditionsPointEventCondition[]Conditions matched against the goal event’s attributes.
is_throw_outboolWhether to remove the user from the journey once the goal is reached.
is_cancel_eventboolWhether this is a negative (cancellation) goal.

Exit points

Anchor link to

terminator

Anchor link to

Ends the journey for the user. POINT_TYPE_EXIT. Empty object ({}) and no outputs.

{ "point_type": "POINT_TYPE_EXIT", "point_data": { "terminator": {} }, "outputs": [] }

Messaging points

Anchor link to

All messaging points send through a channel and share a common envelope. Each has a single default output unless a splitter is enabled (see output keys).

Common fields:

FieldTypeDescription
application_codestringApplication code.
preset_codestringPreset (template) to send. inapp uses richmedia_code instead.
content / titlestringInline message content, when not using a preset (channel-dependent).
campaign_codestringCampaign code for tracking. Created automatically if omitted.
split_paramsBehaviorSplitterOptional: wait for an interaction and branch on it.
message_typeenumMarketing vs transactional message type (controls control-group handling).

Point types and their notable extra fields:

Point typepoint_data keyNotes
POINT_TYPE_SEND_PUSHsend_pushsplit_params (behavior) plus a delivery splitter can produce up to three outputs. send_by_user_id, wait_optimal_time.
POINT_TYPE_SEND_EMAILsend_emailliquid_template_params, personalise. See the Email API.
POINT_TYPE_SEND_SMSsend_smsSee SMS.
POINT_TYPE_SEND_WHATSAPPsend_whatsappA quick-reply preset adds one output per reply (key = reply value). See WhatsApp.
POINT_TYPE_SEND_TELEGRAMsend_telegramTelegram channel.
POINT_TYPE_SEND_KAKAOsend_kakaoSee Kakao.
POINT_TYPE_SEND_LINEsend_lineSee LINE API.
POINT_TYPE_SEND_DATAsend_dataSilent data message (no UI).
POINT_TYPE_INAPPinappUses richmedia_code, expire_in_days, capping.

Shared types

Anchor link to

SegmentRepeat

Anchor link to
FieldTypeDescription
enabledboolWhether recurring entry is on.
frequencystringdaily, weekly, monthly, or dates.
everyuint32Repeat every N periods.
datesstring[]Specific dates, when frequency is dates.
timeSegmentRepeatTimeTime-of-day configuration.

Time objects

Anchor link to
  • ExactTime: { "hour": 0–23, "minute": 0–59 }.
  • ExactDateTime: { "year", "month": 1–12, "day": 1–31, "hour": 0–23, "minute": 0–59 }.

BehaviorSplitter

Anchor link to
FieldTypeDescription
enabledboolWhether to wait for an interaction and branch on it.
intervaluint64Seconds to wait for the interaction.

MultiEntry

Anchor link to

Controls how many active sessions a user can have in the journey at the same time. Mirrors Control how many sessions a user can have at the same time in the Customer Journey builder. Used by the event entry point and wait_event.

FieldTypeDescription
enabledboolWhether a user can have multiple active sessions at the same time. false: one active session per user. true: multiple active sessions per user.
attribute_namestringOptional. Event attribute that scopes each session. When set, a user can have one active session per distinct value of this attribute (for example, one per order_id). Events with the same value share one session. Leave empty to scope all of the user’s entries together.