1. Overview
Webflow is a visual web development platform that empowers users to design, build, and launch responsive websites without writing code. The Webflow CMS (Content Management System) allows for dynamic content structures.
Through the GoInsight Webflow node, you can seamlessly integrate and automate your content management workflows. You can perform full lifecycle management of your CMS Collection Items, including:
- Creating new items in specific collections (e.g., adding new blog posts or products).
- Retrieving details for a single item or listing multiple items with pagination.
- Updating existing items to keep your content fresh.
- Deleting obsolete items from your collections.
2. Prerequisites
Before using this node, please ensure you meet the following requirements:
- Webflow Account: You must have a valid Webflow account.
- Site and CMS: You need at least one Webflow Site with a CMS Collection created.
- API Access: You need an API Token (Site Token or Workspace Token) to authenticate requests.
3. Credentials
For detailed guidelines on how to acquire and configure credentials, please refer to our official documentation: Credential Configuration Guide.
4. Supported Operations
This node allows you to manage content within your Webflow project, specifically focusing on the lifecycle of CMS Collection Items.
Summary
| Resource | Operation | Description |
|---|---|---|
| CMS Collection Item | Create an Item | Create a new CMS Collection Item in Webflow. |
| CMS Collection Item | Get an Item | Get a CMS Collection Item by its ID in Webflow. |
| CMS Collection Item | Get Many Items | Retrieve multiple CMS Collection Items from Webflow by collection ID. |
| CMS Collection Item | Update an Item | Update an existing CMS Collection Item in Webflow. |
| CMS Collection Item | Delete an Item | Deletes a CMS Collection Item by its ID. |
Operation Details
Create an Item
Create a new CMS Collection Item in Webflow.
Input Parameters:
- CollectionId: The unique identifier of the target CMS Collection. Format: 24-character hexadecimal string (e.g., '5c51cc8de4b0f6f4e5f0e1a2'). You can obtain this ID by calling List Collections or Get Collection action.
- Fields: Field data for the new item. Each key is a field slug (the API name of the field), and the value is the field's value. Common field slugs include name, slug, price, description, featured, and publish-date. Note: Available fields depend on your Collection schema. Use Get Collection action to retrieve the complete field list.
Options:
- IsDraft: Whether to create the item as a draft. Draft items are not visible on the published site. Default is false (published item).
- Live: Whether to publish the item to the live site. Default is false (item is created in staging). ⚠️ Warning: Setting this to true will immediately publish the item to your production website. Use with caution in production environments.
Output:
- CollectionItem (object): The created CMS Collection Item. Contains fields like id, createdOn, lastUpdated, lastPublished, and fieldData (the values you provided).
- OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.
- StatusCode (number): Operation status code: 200 (Success), -1 (Parameter validation error), 401 (Invalid access token), 404 (Collection not found), 429 (Rate limit exceeded), 500 (Internal server error).
- ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
Get an Item
Get a CMS Collection Item by its ID in Webflow.
Input Parameters:
- CollectionId: Unique identifier of the CMS Collection (in UUID format - a 24-character alphanumeric identifier, e.g., 5c9c2b3e4f1a2d0011a3b4c5).
- ItemId: The unique identifier of the CMS Collection Item to retrieve.
Options:
- Live: Whether to retrieve items from the published Live site. Set to true to retrieve the published version visible to visitors. Set to false (default) to retrieve the latest version from the Draft environment (including unpublished changes).
Output:
- Item (object): The details of the retrieved CMS Collection Item, containing id, cmsLocaleId, lastPublished, lastUpdated, createdOn, isArchived, isDraft, and fieldData.
- OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.
- StatusCode (number): Operation status code: 200=Success, -1=Parameter validation error, 500=System error.
- ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
Get Many Items
Retrieve multiple CMS Collection Items from Webflow by collection ID with a limit parameter, without pagination.
Input Parameters:
- CollectionId: The unique identifier (in UUID format, 32-character hexadecimal string) of the CMS Collection. Obtainable via the List Collections API.
Options:
- Limit: Maximum number of entries returned per request, range 1-100. Defaults to 50. NOTE: Setting an excessively large value is not recommended as it will consume a significant number of Tokens.
- Offset: Pagination offset, starting from 0. Used to retrieve subsequent page data. Examples: Page 1: offset=0, limit=50; Page 2: offset=50, limit=50.
Output:
- Items (object-array): List of CMS Collection Item objects. Each Item contains standard fields (id, createdOn, etc.) and custom fieldData.
- Count (number): Number of items returned in the current response.
- Pagination (object): Pagination metadata object structure containing offset, limit, total, and has_more.
- OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.
- StatusCode (number): Operation status code: 200=Success, -1=Parameter validation error, 500=System error.
- ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
Update an Item
Update an existing CMS Collection Item in Webflow.
Input Parameters:
- CollectionId: Unique identifier of the CMS Collection (24-character hexadecimal UUID format).
- ItemId: Unique identifier of the Collection Item to be updated (24-character hexadecimal format).
- Fields: Key-value pairs of the fields to be updated. Key is the slug (API Name) of the Webflow field, Value is the corresponding value. IMPORTANT: Field names must exactly match the slugs defined in the Collection Schema (case-sensitive).
Options:
- Live: Whether to publish the updated Item to the production environment (Live Site). true publishes immediately; false (default) saves as a draft. Note: If Auto-publish is enabled on the Collection, this parameter is ignored.
Output:
- UpdatedItem (object): Detailed information of the updated Collection Item, including id, lastUpdated, and the updated fieldData.
- OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.
- StatusCode (number): Operation status code: 200=Success, -1=Parameter validation error, 500=System error.
- ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
Delete an Item
Deletes a CMS Collection Item by its ID. Related Actions: Use List Items or Search Items to find the ItemId before deletion. Use Get Item to verify the item before deletion.
Input Parameters:
- CollectionId: The unique identifier (UUID) of the target CMS Collection.
- ItemId: The unique identifier of the CMS Collection Item to delete. ⚠️ WARNING: Deletion is irreversible, please use with caution.
Output:
- Deleted (bool): Indicates whether the item was successfully deleted.
- OriginalStatusCode (number): The original HTTP status code returned by the upstream API. Use for debugging.
- StatusCode (number): Operation status code: 200=Success, -1=Parameter validation error, 500=System error.
- ErrorMessage (string): Detailed error message if any error occurred. Empty string if the operation succeeded.
5. Example Usage
This section will guide you through creating a simple workflow to add a new item (e.g., a blog post) to your Webflow CMS Collection.
Workflow Overview: Start -> Webflow (Create an Item) -> Answer
Step-by-Step Guide:
- Add Tool Node:
- In the workflow canvas, click the "+" button to add a new node.
- Select the "Tools" tab.
- Search for and select Webflow.
- From the list of supported operations, choose Create an Item.
- Configure Node:
- Click the newly added node to open its configuration panel.
- Credentials: Select your configured Webflow API credential.
- CollectionId: Enter the ID of the Collection where you want to add the item. You can find this in your Webflow Designer URL when viewing the collection settings (e.g., 5c51cc8de4b0f6f4e5f0e1a2).
- Fields: You need to provide a JSON object representing the item's data. The keys must match the "Slug" names defined in your Collection settings. For example, for a blog post:
- Live: Set to false if you want to review it in Staging first, or true to publish immediately.
{ "name": "My New Blog Post", "slug": "my-new-blog-post", "post-body": "This is the content of the post.
", "author": "Jane Doe" } - Run and Verify:
- Ensure all required fields are filled and the error indicator disappears.
- Click the "Run" or "Test Run" button in the canvas.
- Check the execution logs. A successful operation will return a StatusCode of 200 and the CollectionItem object containing the new item's ID.
Result: After completing these steps, a new item will be created in your specified Webflow Collection.
6. FAQs
Q: How do I find my Collection ID?
A: You can find the Collection ID in a few ways:
- Via URL: Open your project in the Webflow Designer, go to the CMS panel, and click the settings gear icon for a specific collection. The ID is the alphanumeric string at the end of the URL.
- Via API: Use the "List Collections" action (if available) or check the Webflow API documentation to list all collections for a site.
Q: Why am I getting a "Validation Error" or status -1?
A: This usually happens when the Fields input is incorrect. Please check:
- Are you using the field Slug (e.g., post-body) and not the display name (e.g., Post Body)?
- Are you providing all fields marked as "Required" in your Webflow Collection settings?
- Is the data type correct (e.g., sending a string for a Number field)?
Q: Can I update an image field?
A: Yes, but it requires a specific format. You typically need to provide the image URL or the file ID object structure as defined by the Webflow API schema.
Leave a Reply.