Changelog Posts
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.
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.
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
Addedschema
andformElementId
properties to theForm 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>
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 thecomponents: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.
- Create Well Known File
Upload or update a.well-known
file to a site. - Delete Well Known File
Remove a.well-known
file from a site when it’s no longer needed.
Site Redirects
- Update Site Redirect
Update an existing URL redirection rule for a site.
Form Submissions
- Delete Form Submission
Remove an individual form submission.
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 capabiliites.
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
- Replace robots.txt: Replace the
robots.txt
configuration for various user agents. - Update robots.txt: Update the
robots.txt
configuration for various user agents. - Delete user-agent rules: Remove specific rules for a user-agent in your
robots.txt
file.
Site Redirects
- Get site redirects: Fetch a list of all URL redirect rules configured for a specific site.
- Create a site redirect rule: Add a new URL redirection rule to a site.
- Delete site redirect rules: Remove URL redirection rule(s) from a site.
Designer API
🆕 New Methods
- Subscribe for alerts when a user selects a new CMS Item in a collection page: When a user selects a collection page or chooses a new CMS item on a collection page, this event will trigger. This can be especially useful for determining the path of auto-generated pages from a CMS or Ecommerce collection.
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
- Get user’s Designer capabilities: Get list of user’s abilities in the designer.
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
- Site Plan Details: Get site plan details for the provided Site (Enterprise only)
🐛 Bug Fixes
- Get Page Content: The response now includes component instances on a page that have modified property values , including: Plain Text, Rich Text, and Alt Text.
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.
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
05.01.2024
Data API
Live Content Management: The latest updates introduce specific endpoints for managing CMS items that are live on a site, ensuring a seamless distinction from content in staging or draft states.
Designer API
Bulk create Elements: Use webflow.elementBuilder
when you need to deploy large or complex designs quickly. This method is especially valuable in scenarios where performance is critical, and the simplicity of the elements aligns with your design objectives.
Create and manage Assets: Easily create assets on your site and manage them with new API endpoints. Retrieve assets by ID and access asset URLs directly to streamline your digital asset management.
Deepen CMS integration: New endpoints allow you to fetch the collection ID and name for pages generated by CMS collections, facilitating a more integrated and automated approach to managing your CMS content.
Data API
What’s New
CMS Items
GET
/collections/{collection_id}/items/{item_id}/live
Get live CMS item
GET
/collections/{collection_id}/items/live
List live CMS items
POST
/collections/{collection_id}/items/live
Create Collection Item (Live)
PATCH
/collections/{collection_id}/items/{item_id}/live
Update Collection Item (Live)
DELETE
/collections/{collection_id}/items/{item_id}/live
Delete Collection Item (Live)
Designer API
What’s New
Elements
webflow.elementBuilder
Create a root element for a new element structure
Assets
webflow.createAsset
Create an asset on a site.
asset.getAssetById
Get Asset by its ID
asset.getUrl
Get Asset’s URL
Pages
page.getCollectionId
Get collection ID of a page generated by a CMS collection
page.getCollectionName
Get collection name of a page generated by a CMS collection