Proactive triggers

Documentation Index

Fetch the complete documentation index at: https://developers.autoplay.ai/llms.txt

Use this file to discover all available pages before exploring further.

New to this? Start with Authoring proactive triggers for a step-by-step walkthrough of building your first trigger.

​

How it works in three steps

User actions → ProactiveTriggerContext → ProactiveTriggerRegistry.evaluate_first()
                                                        ↓
                                          ProactiveTriggerResult  (or None)
                                                        ↓
                                              Your delivery layer
                                         (Intercom quick_reply, modal, etc.)

1. Build context — On each tick, construct a ProactiveTriggerContext from your event buffer (recent actions, canonical URLs, session summary, etc.).
2. Evaluate — Call registry.evaluate_first(ctx). The registry walks its triggers in priority order and returns the first ProactiveTriggerResult whose predicate matches, or None.
3. Deliver — Pass the result’s body and optional reply_option_labels to your delivery layer. Gate on FSM state via can_show_proactive_with_reason before sending.

​

Quickstart

from autoplay_sdk.proactive_triggers import (
    PredicateProactiveTrigger,
    ProactiveTriggerContext,
    ProactiveTriggerRegistry,
)

# 1. Define a trigger
trigger = PredicateProactiveTrigger(
    trigger_id="high_action_volume",
    body="Looks like you've been busy — need a hand?",
    predicate=lambda ctx: ctx.action_count >= 12,
)

# 2. Register it
registry = ProactiveTriggerRegistry([trigger])

# 3. Build context and evaluate on each tick
ctx = ProactiveTriggerContext(
    session_id="sess_abc",
    product_id="prod_xyz",
    action_count=14,
    # ... other fields
)

result = registry.evaluate_first(ctx)

if result:
    print(result.trigger_id)   # "high_action_volume"
    print(result.body)          # "Looks like you've been busy — need a hand?"

​

Module: autoplay_sdk.proactive_triggers

​

Core types

​

Default timing constants

​

Custom payload sources (RecentActionsPayloadSource)

​

Stock event connector: Zep vs context store

​

Built-in trigger IDs

​

user_page_dwell — time on page + sparse actions

1. Dwell time — The time span of that streak is at least dwell_threshold_seconds.
   • Default: 60 (one minute). This is the minimum time the user must stay on the same canonical URL before the trigger can match.
2. Sparse actions — The number of actions in that streak is at most user_page_dwell_max_actions.
   • Default: 5. If the user has more than this many actions on the same URL streak, the trigger does not fire (treats it as active exploration, not passive linger).

​

Section playbook — product_section_playbook + section_playbook

• integration_config.proactive_triggers.section_url_rules — ordered array of { "prefix": "<canonical_url_prefix>", "section_id": "<stable_id>" }. First matching prefix wins (put longer/more specific prefixes first).
• section_url_fallback_id — optional bucket id for URLs that match no prefix (defaults internally to other when resolving unmapped paths).

​

ProactiveTriggerContext fields

​

Event connector JSON (builtins)

{
  "proactive_triggers": {
    "builtins": [
      {
        "id": "canonical_url_ping_pong",
        "name": "URL hesitation",
        "description": "Fires when the user bounces between the same URLs"
      }
    ]
  }
}

• id must match an entry in the built-in catalog (see list_builtin_trigger_catalog()).
• name and description are required non-empty strings — used for display, analytics, and admin UIs.
• interaction_timeout_s and cooldown_s are optional; omit to use the catalog’s defaults.
• registry must be omitted or "default".
• mode: "ping_pong_only" restricts results to canonical_url_ping_pong only.
• Invalid rows raise SdkConfigError and log event=proactive_builtin_spec_invalid.

​

Related pages

• Authoring proactive triggers — Step-by-step: build a trigger, build context, register and evaluate, handle delivery.
• Agent session states — FSM gating (can_show_proactive_with_reason, idle expiry).
• Intercom integration — quick_reply HTTP shape, delete-conversation helpers.
• Typed payloads — SlimAction, ActionsPayload, SummaryPayload.