webflow-api 3.1.4 → 3.2.1

package/.mock/definition/collections.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/collections
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - cms:read
       docs: |
         List of all Collections within a Site.
 
@@ -56,9 +58,19 @@ service:
     create:
       path: /sites/{site_id}/collections
       method: POST
-      auth: true
-      docs: |
-        Create a Collection for a site.
+      auth:
+        - OAuth2:
+            - cms:write
+      docs: >
+        Create a Collection for a site with collection fields.
+
+
+        Each collection includes the required _name_ and _slug_ fields, which
+        are generated automatically. You can update the `displayName` of these
+        fields, but the slug for them cannot be changed. Fields slugs are
+        automatically converted to lowercase. Spaces in slugs are replaced with
+        hyphens.
+
 
         Required scope | `cms:write`
       source:
@@ -151,7 +163,9 @@ service:
     get:
       path: /collections/{collection_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - cms:read
       docs: |
         Get the full details of a collection from its ID.
 
@@ -178,23 +192,135 @@ service:
             collection_id: 580e63fc8c9a982ac9b8b745
           response:
             body:
-              id: 580e63fc8c9a982ac9b8b745
-              displayName: Blog Posts
-              singularName: Blog Post
-              slug: post
-              createdOn: '2016-10-24T19:41:48Z'
-              lastUpdated: '2016-10-24T19:42:38Z'
+              id: 7f15043107e2fc95644e93807ee25dd6
+              displayName: Guide Entries
+              singularName: Guide Entry
+              slug: guide-entry
+              createdOn: '2024-04-12T12:42:00Z'
+              lastUpdated: '2024-04-12T12:42:00Z'
               fields:
-                - id: 23cc2d952d4e4631ffd4345d2743db4e
+                - id: 5e2a1b3c4d5e6f7890a1b2c3
                   isRequired: true
                   isEditable: true
                   type: PlainText
                   slug: name
-                  displayName: Name
+                  displayName: Entry Title
+                  helpText: Name of the entry.
+                - id: 5e2a1b3c4d5e6f7890a1b2c4
+                  isRequired: true
+                  isEditable: true
+                  type: PlainText
+                  slug: slug
+                  displayName: Slug
+                  helpText: Slug of the entry.
+                - id: 6f7e8d9c0b1a2e3d4c5b6a7f
+                  isRequired: false
+                  isEditable: true
+                  type: PlainText
+                  slug: summary
+                  displayName: Summary
+                  helpText: A short summary of the entry.
+                - id: 1a2b3c4d5e6f7a8b9c0d1e2f
+                  isRequired: false
+                  isEditable: true
+                  type: RichText
+                  slug: entry-html
+                  displayName: Entry HTML
+                  helpText: The HTML content of the entry.
+                - id: 7e8d9c0b1a2e3d4c5b6a7f8e
+                  isRequired: false
+                  isEditable: true
+                  type: Image
+                  slug: illustration-image
+                  displayName: Illustration Image
+                  helpText: An image of the entry.
+                - id: 2f3e4d5c6b7a8e9d0c1b2a3f
+                  isRequired: false
+                  isEditable: true
+                  type: VideoLink
+                  slug: demonstration-video
+                  displayName: Demonstration Video
+                  helpText: A video of the entry.
+                - id: 8e9d0c1b2a3f4e5d6c7b8a9e
+                  isRequired: false
+                  isEditable: true
+                  type: Link
+                  slug: more-info-link
+                  displayName: More Info Link
+                  helpText: A link to more information about the entry.
+                - id: 3f4e5d6c7b8a9e0d1c2b3a4f
+                  isRequired: false
+                  isEditable: true
+                  type: Number
+                  slug: importance-level
+                  displayName: Importance Level
+                  helpText: The importance level of the entry.
+                - id: 9e0d1c2b3a4f5e6d7c8b9a0e
+                  isRequired: false
+                  isEditable: true
+                  type: Switch
+                  slug: is-essential
+                  displayName: Is Essential
+                  helpText: Is this entry essential?
+                - id: 4f5e6d7c8b9a0e1d2c3b4a5f
+                  isRequired: false
+                  isEditable: true
+                  type: Color
+                  slug: first-mentioned
+                  displayName: First Mentioned
+                  helpText: Date of the first mention of the subject.
+                - id: 0e1d2c3b4a5f6e7d8c9b0a1e
+                  isRequired: false
+                  isEditable: true
+                  type: Color
+                  slug: towel-color
+                  displayName: Towel Color
+                  helpText: The color of the towel.
+                - id: 5f6e7d8c9b0a1e2d3c4b5a6f
+                  isRequired: false
+                  isEditable: true
+                  type: Reference
+                  slug: related-entry
+                  displayName: Related Entry
+                  helpText: A related entry.
+                - id: 1e2d3c4b5a6f7e8d9c0b1a2f
+                  isRequired: false
+                  isEditable: true
+                  type: MultiReference
+                  slug: mentioned-in-entries
+                  displayName: Mentioned In Entries
+                  helpText: Entries that mention this subject.
+                - id: 6f7e8d9c0b1a2e3d4c5b6a8f
+                  isRequired: false
+                  isEditable: true
+                  type: Option
+                  slug: item-type
+                  displayName: Item Type
+                  helpText: The type of item.
+                - id: 2e3d4c5b6a7f8e9d0c1b2a4f
+                  isRequired: false
+                  isEditable: true
+                  type: File
+                  slug: guide-file
+                  displayName: Guide File
+                - id: 7f8e9d0c1b2a3f4e5d6c8b9e
+                  isRequired: false
+                  isEditable: true
+                  type: Email
+                  slug: contributor-email
+                  displayName: Contributor Email
+                - id: 3a4f5e6d7c8b9a0e1d2c4b5f
+                  isRequired: false
+                  isEditable: true
+                  type: Phone
+                  slug: emergency-contact
+                  displayName: Emergency Contact
     delete:
       path: /collections/{collection_id}
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - cms:write
       docs: |
         Delete a collection using its ID.
 

package/.mock/definition/comments.yml

@@ -0,0 +1,40 @@
+imports:
+  root: __package__.yml
+webhooks:
+  comment_created:
+    audiences: []
+    method: POST
+    display-name: New Comment Thread
+    headers: {}
+    payload: root.Comment
+    examples:
+      - payload:
+          triggerType: comment_created
+          payload:
+            threadId: 679d2ddb5196117ad04d1ffa
+            commentId: 679d2ddb5196117ad04d1ff8
+            type: new_comment
+            siteId: 679826b3b20b045e176bc4b5
+            pageId: 679826b3b20b045e176bc4bc
+            localeId: 67993753d910db250db64b3e
+            breakpoint: main
+            url: >-
+              https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ffa&pageId=679826b3b20b045e176bc4bc
+            content: 'This comment mentions another user [[6287ec36a841b25637c663df]] '
+            isResolved: false
+            author:
+              userId: 6287ec36a841b25637c663df
+              email: ford.prefect@heartofgold.spaceship
+              name: Ford Prefect
+            mentionedUsers:
+              - userId: 6287ec36a841b25637c663df
+                email: arthur.dent@heartofgold.spaceship
+                name: Arthur Dent
+            createdOn: '2025-01-31T20:08:59.759Z'
+            lastUpdated: '2025-01-31T20:08:59.759Z'
+    docs: |
+      Information about a new comment thread or reply
+
+      <Note title="Timing of comment webhooks">
+        There may be a delay of up to 5 minutes before new comments appear in the system and trigger the webhook notification.
+      </Note>

package/.mock/definition/components.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/components
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - components:read
       docs: |
         List of all components for a site.
 
@@ -22,6 +24,9 @@ service:
       request:
         name: ComponentsListRequest
         query-parameters:
+          branchId:
+            type: optional<string>
+            docs: Scope the operation to work on a specific branch.
           limit:
             type: optional<double>
             docs: 'Maximum number of records to be returned (max limit: 100)'
@@ -43,6 +48,10 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            branchId: 68026fa68ef6dc744c75b833
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               components:
@@ -71,7 +80,9 @@ service:
     get-content:
       path: /sites/{site_id}/components/{component_id}/dom
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - components:read
       docs: >
         Get static content from a component definition. This includes text
         nodes, image nodes, select nodes, text input nodes, submit button nodes,
@@ -104,9 +115,15 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
+          branchId:
+            type: optional<string>
+            docs: Scope the operation to work on a specific branch.
           limit:
             type: optional<double>
             docs: 'Maximum number of records to be returned (max limit: 100)'
@@ -131,6 +148,9 @@ service:
             component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            branchId: 68026fa68ef6dc744c75b833
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5
@@ -180,7 +200,9 @@ service:
     update-content:
       path: /sites/{site_id}/components/{component_id}/dom
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - components:write
       docs: >
         This endpoint updates content within a component defintion for
         **secondary locales**. It supports updating up to 1000 nodes in a single
@@ -191,13 +213,18 @@ service:
 
         1. Use the [get component
         content](/data/reference/pages-and-components/components/get-content)
-        endpoint to identify available content nodes and their types
+        endpoint to identify available content nodes and their types.
 
         2. If your component definition has a component instance nested within
         it, retrieve the nested component instance's properties that you'll
         override using the [get component
         properties](/data/reference/pages-and-components/components/get-properties)
-        endpoint
+        endpoint.
+
+        3. DOM elements may include a `data-w-id` attribute. This attribute is
+        used by Webflow to maintain custom attributes and links across locales.
+        Always include the original `data-w-id` value in your update requests to
+        ensure consistent behavior across all locales.
 
 
         <Note>
@@ -221,9 +248,15 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
+          branchId:
+            type: optional<string>
+            docs: Scope the operation to work on a specific branch.
         body:
           properties:
             nodes:
@@ -249,6 +282,7 @@ service:
             component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            branchId: 68026fa68ef6dc744c75b833
           request:
             nodes:
               - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad623
@@ -281,7 +315,9 @@ service:
     get-properties:
       path: /sites/{site_id}/components/{component_id}/properties
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - components:read
       docs: >
         Get the default property values of a component definition.
 
@@ -307,9 +343,15 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
+          branchId:
+            type: optional<string>
+            docs: Scope the operation to work on a specific branch.
           limit:
             type: optional<double>
             docs: 'Maximum number of records to be returned (max limit: 100)'
@@ -334,6 +376,9 @@ service:
             component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            branchId: 68026fa68ef6dc744c75b833
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               componentId: 658205daa3e8206a523b5ad4
@@ -357,17 +402,26 @@ service:
     update-properties:
       path: /sites/{site_id}/components/{component_id}/properties
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - components:write
       docs: >
         Update the default property values of a component definition in a
         specificed locale.
 
 
-        Before making updates, use the [get component
+        Before making updates:
+
+        1. Use the [get component
         properties](/data/reference/pages-and-components/components/get-properties)
         endpoint to identify properties that can be updated in a secondary
         locale.
 
+        2. Rich Text properties may include a `data-w-id` attribute. This
+        attribute is used by Webflow to maintain links across locales. Always
+        include the original `data-w-id` value in your update requests to ensure
+        consistent behavior across all locales.
+
 
         <Note>The request requires a secondary locale ID. If a `localeId` is
         missing, the request will not be processed and will result in an
@@ -390,9 +444,15 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
+          branchId:
+            type: optional<string>
+            docs: Scope the operation to work on a specific branch.
         body:
           properties:
             properties:
@@ -417,6 +477,7 @@ service:
             component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            branchId: 68026fa68ef6dc744c75b833
           request:
             properties:
               - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad623
@@ -435,12 +496,12 @@ types:
   ComponentDomWriteNodesItem:
     discriminated: false
     union:
-      - root.TextNodeWrite
-      - root.ComponentInstanceNodePropertyOverridesWrite
-      - root.SelectNodeWrite
-      - root.TextInputNodeWrite
-      - root.SubmitButtonNodeWrite
-      - root.SearchButtonNodeWrite
+      - type: root.TextNodeWrite
+      - type: root.ComponentInstanceNodePropertyOverridesWrite
+      - type: root.Select
+      - type: root.TextInputNodeWrite
+      - type: root.SubmitButtonNodeWrite
+      - type: root.SearchButtonNodeWrite
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
     inline: true

package/.mock/definition/ecommerce.yml

@@ -7,7 +7,9 @@ service:
     get-settings:
       path: /sites/{site_id}/ecommerce/settings
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:read
       docs: |
         Retrieve ecommerce settings for a site.
 

package/.mock/definition/forms.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/forms
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:read
       docs: |
         List forms for a given site.
 
@@ -45,6 +47,9 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               forms:
@@ -94,7 +99,9 @@ service:
     get:
       path: /forms/{form_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:read
       docs: |
         Get information about a given form.
 
@@ -149,7 +156,9 @@ service:
     list-submissions:
       path: /forms/{form_id}/submissions
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:read
       docs: |
         List form submissions for a given form
 
@@ -192,6 +201,9 @@ service:
       examples:
         - path-parameters:
             form_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            offset: 1.1
+            limit: 1.1
           response:
             body:
               formSubmissions:
@@ -218,7 +230,9 @@ service:
     get-submission:
       path: /form_submissions/{form_submission_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:read
       docs: |
         Get information about a given form submissio.
 
@@ -257,7 +271,9 @@ service:
     delete-submission:
       path: /form_submissions/{form_submission_id}
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:write
       docs: |
         Delete a form submission
 
@@ -284,7 +300,9 @@ service:
     update-submission:
       path: /form_submissions/{form_submission_id}
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:write
       docs: |
         Update hidden fields on a form submission
 
@@ -335,7 +353,9 @@ service:
     list-submissions-by-site:
       path: /sites/{site_id}/form_submissions
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:read
       docs: >
         List form submissions for a given site. This endpoint differs from the
         existing [List Form Submissions
@@ -385,6 +405,8 @@ service:
             site_id: 580e63e98c9a982ac9b8b741
           query-parameters:
             elementId: 18259716-3e5a-646a-5f41-5dc4b9405aa0
+            offset: 1.1
+            limit: 1.1
           response:
             body:
               formSubmissions:
@@ -412,3 +434,39 @@ service:
     openapi: ../../../openapi/referenced-specs/v2.yml
   display-name: Forms
 docs: Forms are forms that are created on your Webflow site.
+webhooks:
+  form_submission:
+    audiences: []
+    method: POST
+    display-name: Form Submission
+    headers: {}
+    payload: root.FormSubmissionTrigger
+    examples:
+      - payload:
+          triggerType: form_submission
+          payload:
+            name: Contact Us
+            siteId: 65427cf400e02b306eaa049c
+            data:
+              First Name: Zaphod
+              Last Name: Beeblebrox
+              email: zaphod@heartofgold.ai
+              Phone Number: 15550000000
+            schema:
+              - fieldName: First Name
+                fieldType: FormTextInput
+                fieldElementId: 285042f7-d554-dc7f-102c-aa10d6a2d2c4
+              - fieldName: Last Name
+                fieldType: FormTextInput
+                fieldElementId: 285042f7-d554-dc7f-102c-aa10d6a2d2c5
+              - fieldName: email
+                fieldType: FormTextInput
+                fieldElementId: 285042f7-d554-dc7f-102c-aa10d6a2d2c6
+              - fieldName: Phone Number
+                fieldType: FormTextInput
+                fieldElementId: 285042f7-d554-dc7f-102c-aa10d6a2d2c7
+            submittedAt: '2022-09-14T12:35:16.117Z'
+            id: 6321ca84df3949bfc6752327
+            formId: 65429eadebe8a9f3a30f62d0
+            formElementId: 4e038d2c-6a1e-4953-7be9-a59a2b453177
+    docs: Information about a form that was subitted