For AI agents: the docs index is at https://docs.recurly.com/recurly-engage/llms.txt. The index for every project on this site is at https://docs.recurly.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Attribute Description Values paths Array of prompts for which the end user is eligible See here for prompt attributes path_segments Only utilized by SDK segments Array of Segment objects See here for Segment attributes configs Config object See here for Config attributes reset Indicate whether client should reset state for current end user true, false anonymous_user_id Unique anonymous identifier for end user. This automatically generated by Redfast unless specified by the client. visitor_id Authenticated identifier for end user
Attribute Description Values id Unique identifier for Prompt name Name of prompt device_type Device type to which prompt applies web, ios, tv_os, android_os, roku_os (addl custom device types may be available) path_type Prompt type 1 = invisible, 2 = popup, 5 = horizontal, 6 = video, 7 = text, 8 = vertical, 9 = tile, 10 = interstitial, 11 = notification, 13 = bottom banner triggers Array of Triggers objects See here for Trigger attributes action_group_id ID of variation assigned to end user actions Prompt attributes See here for description of all attributes display_type Guidance on how the inline prompt (i.e. horizontal, vertical) should be rendered by the SDK stack (default), slider, list path_group_slug SDK specific identifier for Zone zone Name of zone utilized by inline prompt zone_type Zone type code (default), live (only applies to JS SDK) order Order in which inline prompts should be rendered <integer>website_actions Custom code to be executed upon prompt interaction (Only utilized by SDK) settings SDK specific rendering settings
Attribute Description Values id Unique identifier for Segment name Name of Segment
Attribute Description Values id Unique identifier for Trigger trigger_type Platform value for trigger web, device url_path URL path or screen name can be regexp url_hash (optional) click_id (optional) ID of click target For browsers, can be CSS style selector. query_params (optional) delay_seconds Number of seconds to wait before rendering prompt <number of seconds>click_count_threshold Number of times click_id is invoked betwen triggering prompt <integer>use_regex Specify whether url_path should be considered a regexp true, false inject Only utilized by SDK custom_trigger_args Only utilized by SDK custom_trigger_seconds Only utilized by SDK
Attribute Description Values id Unique identifier for Trigger ping_frequency Number of seconds client should wait before issuing next Ping request <integer>last_update Epoch of time at which response objecdt was last updated <epoch timestamp>device_type Device type to which prompt applies web, ios, tv_os, android_os, roku_os (addl custom device types may be available) autoingest Only utilized by SDK
