Migrating to v2

We're thrilled to announce the evolution of our developer platform with v2 Apps and APIs. The upgrades to our v2 API are not just about enhancing Webflow’s technical capabilities. They're also a new opportunity to forge a more secure, efficient, and developer-friendly environment. With the introduction of scopes and a more expansive Data API, we're taking a step forward in giving both developers and users more control and clarity.

If you've previously developed an with v1, here's your guide to make the transition to v2 as seamless as possible:

  1. Creating a new v2 App
    To utilize v2 resources, you'll need to create a brand new app. Please use this step-by-step guide to help you through this process.

  2. v1 Apps are now ‘Data Clients’
    Your previous App is now what we’re calling a 'Data Client'. Here's a quick rundown of what that means:

    • Data Clients access specific site data, spanning from CMS to Ecommerce, as well as new resources like Assets, Pages, and Custom Code.
    • They leverage our REST APIs to fetch this information.
    • For those keen on real-time updates, Data Clients can send event notifications through Webhooks.
  3. Data API Changes
    We've made significant updates to our Data API, including updates, additions, and removals to key endpoints. For a thorough overview of what we’ve modified, visit our changelog of:

  4. Introducing Scopes: More Control, More Precision
    We’ve incorporated 'scopes’ into the latest version of our Data API. Designed to specify an App’s permissions, scopes ensure that users have clearer control over the data an App can access and take action upon. It's a step towards more transparency and security. Developers, for a granular approach to permissions, ensure you're aligned with our Scopes Guide.

  5. Updates to our JavaScript SDK
    We're currently revamping our SDK to provide robust support for our v2 APIs. In the meantime, if you're leveraging our JavaScript SDK, please:

    • Update to the most recent SDK version.

    • Modify your code to call our APIs directly, rather than using our pre-built helper functions. Here's a brief example on how to do that:

      // call the sites endpoint directly
      const sites = await webflow.get("/sites");
      
      // post to an endpoint directly
      const result = await webflow.post("/sites/[SITE ID]/publish", {
        domains: ["hello-webflow.com"],
      });
      
      
  6. Re-submit your App to the Marketplace
    Once you've updated your app to align with v2, you can share these updates by re-submitting your App to the Marketplace. We’ve updated some of our guidance on Marketplace submissions and listings, so please refer to this guidance before submitting your App.

We’re incredibly thankful that you’ve taken the time to build on our original set of APIs; and we're looking forward to seeing what you build with the new functionality in v2. If you have any questions or need further assistance during this transition, our team and resources are here to support you every step of the way.