Migrating to v2

We know migrating APIs can be challenging, but we’re excited to help you upgrade to v2. The new version brings powerful capabilities that will let you build even better experiences for your users. Let’s walk through how to migrate your existing v1 App:

v2 Apps and API changes

• v1 Apps are now named ‘Data Clients’ The v2 equivalent of v1 Apps are named ‘Data Clients’. This is a change from the previous naming convention of ‘Apps’. Here’s a quick rundown of what that means:

  • Data Clients access site data, spanning from the CMS to Ecommerce, as well as new resources like assets, pages, and custom code. For an overview of the v2 API resources, see the v2 API reference docs.
  • Data Clients leverage Webflow’s REST APIs to fetch this information.
  • For use cases that require real-time updates, Data Clients can send event notifications through webhooks.

• Data API changes The v2 API includes significant changes to Webflow’s REST APIs, including updates, additions, and removals to key endpoints. For a thorough overview of what’s changed, see the Data API changelog.

  To explore the current v2 API offerings, check out the reference docs.

• Introduction of scopes The new version of the API incorporates scopes into the authorization process. Scopes specify an App’s permissions, ensuring that users have clearer control over the data an App can access and act upon. It’s a step towards more transparency and security. For a granular approach to permissions, make sure you’re aligned with Webflow’s guidance on scopes.

• Updates to the JavaScript SDK We’re currently revamping the JavaScript SDK to provide robust support for the v2 APIs. In the meantime, if you’re using the JavaScript SDK, please:

  • Update to the most recent SDK version.
  • Use TypeScript/Intellisense in your code editor to guide API usage after instantiating a client. You may also find SDK snippets in the API reference docs examples. Here’s a brief example on usage:
  JavaScript

  1
     import { WebflowClient } from "webflow-api";
  2
  3
     const webflow = new WebflowClient({ accessToken });
  4
  5
     // Env. variables
  6
     // in format of string, e.g.: "639656400769508adc12fe42"
  7
     const siteId = process.env.SITE_ID;
  8
     const customDomainId1 = process.env.CUSTOM_DOMAIN_ID_1;
  9
     const customDomainId2 = process.env.CUSTOM_DOMAIN_ID_2;
  10
  11
     // Sites
  12
  13
     // List Sites
  14
     const sites = await webflow.sites.list();
  15
  16
     // Get Site
  17
     const site = await webflow.sites.get(siteId);
  18
  19
     // Get Custom Domains
  20
     const customDomains = await webflow.sites.getCustomDomain(siteId);
  21
  22
     // Publish Site
  23
     const site = await webflow.sites.publish(siteId, {
  24
        customDomains: [customDomainId1, customDomainId2],
  25
        publishToWebflowSubdomain: true,
  26
     });