Interactions
webflow.interactions lets an extension list, read, create, set, and remove interactions on the current site or page. Writes reflect live on the canvas, are undoable (Cmd+Z), and sync to collaborators.
The API reads and writes Interactions with GSAP. It does not read or write Classic Interactions, so getAll returns an empty list on a site that only uses Classic Interactions.
Writes accept six trigger types: click, hover, page load, scroll, mouse move, and custom event.
- Interaction schema lists every field and value the API accepts.
- Interaction examples has a complete
createcall for each trigger type.
The TypeScript types leave value, properties, pluginConfig, and triggerMetadata open (unknown or Record<string, unknown>). They may narrow to specific types in a future major version.
Reads need the canReadInteractions Designer Ability. Writes need canModifyInteractions.