APIsChangelog
Log In

Migrating to v2

We're excited to introduce the new version of Webflow's Designer APIs, featuring enhanced functionality and more efficient methods for interacting with the Designer. To ensure your app remains compatible, please follow the simple steps provided for updating your app's configuration and codebase. Check the details below.

Notable Changes

Simplified edit semantics

We have removed the .save() method from many of our objects. Rather than staging “local changes” and explicitly synchronizing via element.save(), we’re now making changes as they’re invoked.

Accessing native Elements

Through the introduction of the Element Presets Object, the API now allows Apps to insert native Elements onto the canvas.

Inserting Elements

We’re introducing new helper methods that make it easier to insert elements into a hierarchy

  • element.append()
  • element.prepend()
  • element.before()
  • element.after()

We've removed element-specific methods for adding an element to a canvas including

  • createDOM()
  • createString()
  • createHeading()

Direct editing of Components

This API allows a more streamlined way to edit Component Objects, by accessing the root element of a Component Object.

Clear and consistent naming

We've made minor changes to clarify Designer API functionality

  • “Folders” → “PageFolders” to disambiguate versus other Page resources (eg. Asset pages)
  • “og-” -> “openGraph-” prefix for Open Graph Page Fields

Clear and consistent return objects

  • Most methods that aren't meant to return a value now return a Promise that resolves to null instead of undefined
  • Element IDs are now identified by their component and element ids, eg. id: {component: '63486e4622e33733b9002e9c', element: 'cafe0045-d304-79d9-8f68-af3adaed06e8'}

App configuration Updates

  1. Install the latest version of the Webflow CLI
  2. Install the latest type definitions for the Designer APIs 
npm i @webflow/[email protected]
  1. Update webflow.json to include the new apiVersion parameter.
{
  "name": "My Webflow App",
  "publicDir": "dist",
  "apiVersion": "2"
}
  1. Start your development server.

Code Adjustments

Remove any references to .save()

// v1
await myElement.setStyles([styles])
await myElement.save()

// v2
await myElement.setStyles([styles])

Adjust logic to access Element IDs

// v1
const selectedElement = await webflow.getSelectedElement()
console.log(selectedElement)
// Prints: 'cafe0045-d304-79d9-8f68-af3adaed06e8'

// v2
const selectedElement = await webflow.getSelectedElement()
console.log(selectedElement)
// Prints id: {component: '63486e4622e33733b9002e9c', element: 'cafe0045-d304-79d9-8f68-af3adaed06e8'}\`

const elementID = selectedElement?.id.element
// Returns: 'cafe0045-d304-79d9-8f68-af3adaed06e8'

Adjust logic for element insertion

// v1
const newDiv = await webflow.createDOM('div')

// v2
const selectedElement = await webflow.getSelectedElement()
const newDiv = await selectedElement?.before(webflow.elementPresets.DivBlock)