Design the moment before writing the integration.

01 · AVAILABLE TODAY

Turn a product moment into a working interaction.

Use this guide when you are shaping how a Peekling feels inside a product. In the playground, you can choose a character, tune placement and movement, map browser or application Events to reactions, and inspect the exact Plan JSON used by the live Peekling instance.

02 · START WITH A MOMENT

Describe one thing the product already knows.

Begin with a concrete fact. A song starts. A document saves. A job finishes. A visitor reaches the next install step. The host application already knows when that fact is true, so it can report one named Event to Peekling.

• Name the Event after what happened, such as document.saved.
• Choose the smallest character response that makes the moment clearer.
• Decide when the response ends and how the baseline returns.
• Keep dismissal and reduced motion in the experience from the start.

03 · MAP THE RESPONSE

Events describe facts. Effects describe presentation.

The host still owns music, timers, forms, saved data, game rules, and other product logic. Peekling owns the bounded response declared by the Plan.

04 · PROTOTYPE IT

Change one variable at a time.

1. Choose a Pack whose existing States fit the intended moment.
2. Set a calm baseline for quiet moments.
3. Add one Rule for the Event you want to test.
4. Try the behavior with pointer, keyboard, touch, and reduced motion.
5. Copy the Plan JSON when the complete loop feels clear.

A clear prototype shows the trigger, visible response, end condition, and return to baseline. Keep simplifying the Rule until each part reads clearly, then add the next interaction.

05 · DEVELOPER HANDOFF

Hand over a behavior someone can build.

Include these details with the prototype:

• The selected Pack and exact version or immutable manifest URL.
• The complete Plan JSON shown in the playground.
• Application Event names and the bounded payload each one carries.
• The intended timing, baseline, dismissal, and recovery behavior.
• The character States and viewport sizes that need product review.

06 · CURRENT SCOPE

Keep product logic in the host application.

The Plan describes bounded presentation. The host application deploys the website, runs music, timers, forms, saves, and game rules, and mounts any interactive surfaces through trusted host code. The application team owns implementation, security, and cleanup for those controls.

07 · NEXT STEP