Changelog

January 16, 2025

01.16.25

Data API v2

  • Delete form submission endpoint.
    This endpoint allows you to delete a form submission from a site.
  • Added the lastPublished parameter to the customDomains object.
    This parameter returns the date and time of the last published version of a site’s custom domain. This parameter will appear in the response for the get custom domains endpoint, as well as the list sites and get site endpoints.

JavaScript SDK — Data API v2

  • Version 3.1.0 is now available and up to date with the latest changes in the Data API v2.

Data API BETA

  • Create reference fields in a collection.
    To create a reference field, choose MultiReference or Reference as the type property in the field object. Additionally, include the metadata property to specify the collectionId of the collection that the reference field will point to. You can create a reference field during collection creation using the create collection endpoint or by updating an existing collection using the create collection field endpoint.
  • Create collection fields during collection creation.
    You can now create multiple collection fields during collection creation using the create collection endpoint. Collections are limited to 60 fields per collection.

Designer API

December 17, 2024

12.17.24

New Endpoints

Site Redirects A new set of endpoints to manage redirects for a site.

Workspace Management A new set of endpoints to manage sites within a workspace.

  • Create Site
    A new endpoint to create a site for a workspace.
  • Update Site
    A new endpoint to update a site for a workspace.
  • Delete Site
    A new endpoint to delete a site for a workspace.
Updated publishing behavior

Starting December 2024, Webflow is introducing an improved publishing workflow for collection items. When a live item’s isDraft property is set to true, the item will continue to remain published on the live site even after a full site publish. This allows users to make updates to the collection item in a draft state without changing what is visible on the live site.

To remove an item from the live site, you must now explicitly call the unpublish endpoint. This change gives developers more precise control over the publishing state of individual items. Please see the “publishing items” section of the CMS guide for more details.

  • Create CMS Item
    The default behavior of the createItem API is now to create a draft item. All new items will be created with the isDraft flag set to true.
  • Publish CMS Item
    Due to changes in how publishing is handled, sites with multiple domains are longer required to have their domains in sync when publishing a single CMS Item. Previously, users would receive a 409 error when attempting to publish a CMS item while the domains were not in sync. Users will no longer receive a 409 error when attempting to publish a CMS item.

CMS APIs

  • Update page content
    Updated properties in the request body. To update a nested Component Instance within a Component, use the propertyOverrides property instead of using the properties property, .
  • Update component content
    Updated properties in the request body. To update a nested Component Instance within a Component, use the propertyOverrides property instead of using the properties property, .

Breaking Changes

CMS APIs

Deleting collections and collection fields
Deleting a Collection is now achieved through client.collections.delete(), which was previously an API used to delete a Collection field. The method client.collections.deleteCollection() has been removed.

  • CHANGED: To delete a Collection, use: client.collections.delete(collectionId)
  • NEW: To delete a Collection field, use: client.collections.deleteField(collectionId, fieldId)
  • REMOVED: client.collections.deleteCollection()

Creating CMS items
Creating multiple CMS items across multiple locales is now achieved through client.collections.createItems(), which was previously achieved through client.collections.createItemForMultipleLocales().

  • CHANGED: client.collections.createItems()
  • REMOVED: client.collections.createItemForMultipleLocales()
1const newItems = client.collections.items.createItems(collectionId, {
2    cmsLocaleIds: [primaryCmsLocaleId, secondaryCmsLocaleId],
3    isArchived: false,
4    isDraft: false,
5    fieldData: {
6        name: "My Item For Multiple Locales",
7        slug: "my-item",
8        "plain-text": "foo",
9    },
10});

Pages APIs

  • Localization
    The locale query parameter is now localeId.
    • CHANGED: locale -> localeId

New features

Fixes

  • Some APIs that created resources (i.e. collections.items.createItem()) had request payload types that required an id, which is not possible to provide. This is no longer required.
  • fieldData type in CMS Items now allows arbitrary extra key/value pairs - allowing the creation of CMS Items with custom fields.

New methods

November 21, 2024

11.21.24

Changelog: November 21, 2024

Discover the latest updates to the Webflow Data API, including enhancements for bulk CMS authoring, new locale parameter conventions, and beta API improvements.

Data API v2

Updated Endpoints

Improvements to Bulk CMS Authoring via Create Collection Item(s)
You can now create multiple CMS items using the original POST endpoint for creating collection items. By including the items property in your request, you can pass either a single item object or an array of objects. This functionality complements the bulk Create Items endpoint, offering more flexibility for CMS authoring.

Introducing the localeId Parameter
To align with our updated query parameter naming conventions, we’re introducing the localeId parameter as a replacement for locale. While locale is still supported for compatibility, localeId is now the preferred parameter. The following endpoints are affected:

Data API BETA

New Endpoints

List Form Submissions by Site
This endpoint differs from the existing List Form Submissions endpoint by accepting siteId as a path parameter and elementId as a query parameter. Use this parameter to filter submissions on a site by the formElementId. This is particularly helpful for forms included in components, which are given a different formId for each component instance, while still keeping the same formElementId across instances. The formElementId is an attribute from each form object in the List Forms API. Using this endpoint, you can pass the siteId and the formElementId to get all form submissions for a single form that appears in multiple component instances.

Updated Endpoints

Introducing the localeId Parameter
To align with our updated query parameter naming conventions, we’re introducing the localeId parameter as a replacement for locale. While locale is still supported for compatibility, localeId is now the preferred parameter. The following endpoints are affected:

For additional details, visit our Data API documentation.

October 23, 2024

10.23.24

We’re thrilled to introduce powerful new features to the Data API. We’ve added bulk CMS item authoring, editing, and deleting, supporting up to 100 items per request. These endpoints can help manage previous rate limit issues and makes managing large content sets more efficient.

Data API v2

Updated Endpoints

  • Create Collection Items Create a single item or multiple items in a Collection. This endpoint supports creating items across multiple locales and can update up to 100 items in a request.

🆕 New Endpoints

Bulk Staged Items

  • Update Collection Items
    Update a single item or multiple items in a Collection. This endpoint can update up to 100 items in a request.
  • Delete Collection Items
    Delete Items from a Collection. This endpoint can delete up to 100 items in a request.

Bulk Live Items

  • Update Live Collection Items
    Update a single live item or multiple live items in a Collection. This endpoint can update up to 100 items in a request.
  • Delete Live Collection Items
    Remove an item or multiple items from the live site. Deleting published items will un-publish the items from the live site and set them to draft. This endpoint can delete up to 100 items in a request.
October 1, 2024

10.01.24

We’re thrilled to introduce powerful new features across both the Data API and Designer Extensions. We’ve added bulk CMS item authoring, editing, and deleting, supporting up to 100 items per request. These endpoints can help manage previous rate limit issues and makes managing large content sets more efficient. We’ve also introduced deep linking to Hybrid Apps, allowing seamless transitions into the Designer with your App automatically launched.

Data API BETA

🆕 New Endpoints

  • Update Collection Items
    Update a single item or multiple items in a Collection. This endpoint can update up to 100 items in a request.
  • Delete Collection Items
    Delete Items from a Collection. This endpoint can delete up to 100 items in a request.
  • Update Live Collection Items
    Update a single live item or multiple live items in a Collection. This endpoint can update up to 100 items in a request.
  • Delete Live Collection Items
    Remove an item or multiple items from the live site. Deleting published items will un-publish the items from the live site and set them to draft. This endpoint can delete up to 100 items in a request.
  • Update Localized Component Properties
    Update the properties of a component definition in a specified locale.

Updated Endpoints

  • Create Collection Items
    Create a single item or multiple items in a Collection. This endpoint can update up to 100 items in a request.
    Note: This endpoint was previously used to create a single Collection Item for multiple locales. The endpoint can now handle requests for multiple items in multiple locales.

Updated Payloads

  • Form Submission
    Added schema and formElementId properties to the Form Submission webhook payload for better form visibility

Designer API

🆕 New Feature

  • Seamless Integration with Deep Links in Hybrid Apps
    Enhance the transition between third-party experiences and your Designer Extension by utilizing deep links. With deep links, users are directed straight to their site in the Designer with your app automatically launched, ensuring a smooth, uninterrupted workflow. You can construct a deep-link with the following format:
    <site short name>.design.webflow.com?app=<client id>

September 17, 2024

09.17.24

We’ve made a number of updates to the Data API to help you better manage components and site configurations, alongside improvements to page content handling. These changes include new endpoints for retrieving components and their properties, as well as additional functionality for .well-known files and URL redirects.

Data API BETA

🆕 New Endpoints

Page Content & Components

Components are powerful, reusable blocks used to create consistent layouts across your site. Learn more about components in the Webflow University lesson.

New scope for components endpoints
These endpoints will require the components:read scope.
  • Get all components for a site Retrieve all components for a site. This makes it easier to programmatically access reusable design elements.
  • Get static content for a component Retrieve static content for a specific component. Note that dynamic content set via props is not included—use the Get Component Properties endpoint for that.
  • Get component properties Retrieve detailed information about component-specific properties for a more dynamic and customizable component experience.

Well Known Files

Webflow supports the management of .well-known files, which are commonly used for site verification and configuration with external services. At this time, Webflow only accepts the following .well-known files:

  • apple-app-site-association
    Used for iOS Universal Links, allowing apps to handle specific web URLs.
  • apple-developer-merchantid-domain-association
    Used to verify your domain for Apple Pay on the web.

Site Redirects


Form Submissions

Deleting form submissions will also delete the file submissions and make the submitted file URLs inaccessible. Before you delete your form submission data, back up any file uploads you want to keep.


🆕 Updated Endpoints

  • Get Page Content Now returns component instances present on a page. Note: Component instances are included only when their default property values have been modified. Additionally, only the modified properties are returned, while the component’s static content remains excluded.
  • Update Page Content Update properties on component instances directly. Use the Get Page Content endpoint to identify component IDs, and the Get Component Properties endpoint to retrieve the relevant component properties. When updating a component instance, include a list of component properties with their IDs and values. This update supports plain text, rich text, and component instances.

Designer API

🆕 New Methods

  • Subscribe to mode changes in the Designer
    Get a notification when a user changes modes in the Designer. Throughout their workflow and/or depending on their permissions, users can use the Designer in a variety of modes, which affect an App’s capabilities. See the App Modes documentation for a full explanation of modes and capabilities.
August 22, 2024

08.23.24

In this latest release, we’ve rolled out some significant updates to our APIs. First up, we’ve strengthened security by ensuring that only Workspace Admins can manage changes to Apps. In the Data API, we’ve introduced new endpoints that give you greater control over robots.txt files and site redirects. And for those using the Designer API, you can now subscribe to alerts when users select new CMS items on collection pages, making it simpler to keep track of auto-generated page paths.

Security & permissions

  • Enhanced Workspace App Management Permissions:
    Previously, all members within a Workspace had the ability to manage Apps (e.g., uploading new bundles, updating redirect URIs). We have now enforced stricter permissions, allowing only Workspace Admins to perform these actions. This ensures that sensitive operations are restricted to authorized personnel.
  • Mandatory 2FA for Workspace Admins:
    To further enhance security, Workspace Admins are now required to have two-factor authentication (2FA) enabled to upload new App Bundles. This additional security layer helps protect your Workspace from unauthorized access and potential threats.

🆕 SDK Version

🆕 New Endpoints

Static Files

Site Redirects

Designer API

🆕 New Methods

August 9, 2024

08.09.24

In this latest release, we’ve added new endpoints to the Data API giving you more tools to access site configurations, and new methods to the Designer API, allowing you to determine a user’s permissions and capabilities in the Webflow Designer.

🆕 New Endpoints

  • Get robots.txt: Retrieve the robots.txt configuration for various user agents.

Designer API

🆕 New Methods

July 25, 2024

07.30.24

In this latest release, we’ve added new Data API endpoints to assist with programmatic Workspace administration. Additionally, we’ve introduced Designer API methods for adjusting links within the Designer. We’ve also expanded the Get Page Content endpoint to include component instances with modified property values..

🆕 New Endpoints

🐛 Bug Fixes

Designer API

🆕 New Methods

  • Get Link Target: Get the target value of the link block element.
  • Set Link Block Settings: Apply settings for a Link Block element. Including the type of link, its value, and metadata settings.
June 18, 2024

06.18.2024

Optimize data retrieval with server-side CMS item filtering and sorting, manipulate assets and interact with native image elements within the Webflow Designer, and identify page types with new methods.

Data API

CMS Item Filtering and Sorting: Implement server-side filtering and sorting to optimize data retrieval and minimize the number of queries needed. Enable precise filtering and sorting of CMS items by exact name and slug, as well as by lastPublished date ranges, to provide more control over the data returned.

Additional Page Details Get information for a specified page’s localeId as well as the publishedPath .

Designer API

Do more with Assets: Introduce methods to retrieve and manipulate assets directly within the Webflow Designer.

Work with Native Image Elements: Enable advanced interactions with native Image elements on the canvas, including methods to retrieve and set assets and alt text.

Additional Page Information: New method to determine a type of page within the Designer.

Data API

What’s Updated

CMS Items

GET /collections/{collection_id}/items

List CMS items

GET /collections/{collection_id}/items/live

List live CMS items

Page Details

GET /pages/{page_id}

Get metadata information for a single page.

Designer API

What’s New

Elements

element.getAsset()

Retrieve an asset from an Image element.

setAsset()

Add an asset to an Image element.

getAltText()

Retrieve the Alt Text for an Image element on the canvas.

setAltText()

Assets

webflow.getAllAssets()

Retrieve all assets on a site.

asset.getName()

Retrieve name of specified asset.

asset.getMimeType()

Retrieve the MIME Type of a specified asset.

asset.getAltText()

Retrieve the Alt Text for a specific Asset.

asset.setAltText(altText:string)

Set the Alt Text for a specific Asset.

Pages

page.getKind

Get Webflow page type. Possible values are: static, ecommerce, cms, userSystems, utility, staticTemplate

Older posts
Built with