webflow-api 3.1.4 → 3.2.0

package/.mock/definition/collections.yml

@@ -57,8 +57,16 @@ service:
       path: /sites/{site_id}/collections
       method: POST
       auth: true
-      docs: |
-        Create a Collection for a site.
+      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:
@@ -178,19 +186,129 @@ 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

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

@@ -22,6 +22,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 +46,8 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            branchId: 68026fa68ef6dc744c75b833
           response:
             body:
               components:
@@ -107,6 +112,9 @@ service:
             docs: >-
               Unique identifier for a specific locale. Applicable, when using
               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 +139,7 @@ service:
             component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            branchId: 68026fa68ef6dc744c75b833
           response:
             body:
               componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5
@@ -224,6 +233,9 @@ service:
             docs: >-
               Unique identifier for a specific locale. Applicable, when using
               localization.
+          branchId:
+            type: optional<string>
+            docs: Scope the operation to work on a specific branch.
         body:
           properties:
             nodes:
@@ -249,6 +261,7 @@ service:
             component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            branchId: 68026fa68ef6dc744c75b833
           request:
             nodes:
               - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad623
@@ -310,6 +323,9 @@ service:
             docs: >-
               Unique identifier for a specific locale. Applicable, when using
               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 +350,7 @@ service:
             component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            branchId: 68026fa68ef6dc744c75b833
           response:
             body:
               componentId: 658205daa3e8206a523b5ad4
@@ -393,6 +410,9 @@ service:
             docs: >-
               Unique identifier for a specific locale. Applicable, when using
               localization.
+          branchId:
+            type: optional<string>
+            docs: Scope the operation to work on a specific branch.
         body:
           properties:
             properties:
@@ -417,6 +437,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 +456,12 @@ types:
   ComponentDomWriteNodesItem:
     discriminated: false
     union:
-      - root.TextNodeWrite
-      - root.ComponentInstanceNodePropertyOverridesWrite
-      - root.SelectNodeWrite
-      - root.TextInputNodeWrite
-      - root.SubmitButtonNodeWrite
-      - root.SearchButtonNodeWrite
+      - type: root.Text Node
+      - type: root.Component Instance
+      - type: root.Select
+      - type: root.Text Input
+      - type: root.Submit Button
+      - type: root.Search Button
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
     inline: true

package/.mock/definition/forms.yml

@@ -412,3 +412,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

package/.mock/definition/inventory.yml

@@ -122,3 +122,23 @@ types:
     inline: true
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
+  EcommInventoryChangedPayload:
+    properties:
+      triggerType: optional<literal<"ecomm_inventory_changed">>
+      payload: optional<root.InventoryItem>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+webhooks:
+  ecomm_inventory_changed:
+    audiences: []
+    method: POST
+    display-name: Updated eComm Inventory
+    headers: {}
+    payload: EcommInventoryChangedPayload
+    examples:
+      - name: WebhookInventoryChanged
+        payload:
+          triggerType: ecomm_inventory_changed
+          payload:
+            ref: ./schemas/inventory.yml#/InventoryItem/example
+    docs: Information about updated ecommerce inventory values

package/.mock/definition/items.yml

@@ -0,0 +1,99 @@
+imports:
+  root: __package__.yml
+webhooks:
+  collection_item_created:
+    audiences: []
+    method: POST
+    display-name: Collection Item Created
+    headers: {}
+    payload: root.CollectionItemCreated
+    examples:
+      - payload:
+          triggerType: collection_item_created
+          payload:
+            id: 580e64008c9a982ac9b8b754
+            workspaceId: 625860a7a6c16d624927122f
+            siteId: 65427cf400e02b306eaa049c
+            collectionId: 664243617fcc8b464b23c4ee
+            cmsLocaleId: 681442a144bb80bd00480fda
+            lastUpdated: '2023-03-17T18:47:35Z'
+            createdOn: '2023-03-17T18:47:35Z'
+            isArchived: false
+            isDraft: false
+            fieldData:
+              name: Pan-Galactic Gargle Blaster
+              slug: pan-galactic-gargle-blaster
+    docs: Information about a new collection item
+  collection_item_changed:
+    audiences: []
+    method: POST
+    display-name: Collection Item Updated
+    headers: {}
+    payload: root.CollectionItemChanged
+    examples:
+      - payload:
+          triggerType: collection_item_changed
+          payload:
+            id: 580e64008c9a982ac9b8b754
+            workspaceId: 625860a7a6c16d624927122f
+            siteId: 65427cf400e02b306eaa049c
+            collectionId: 664243617fcc8b464b23c4ee
+            cmsLocaleId: 681442a144bb80bd00480fda
+            lastUpdated: '2023-03-17T18:47:35Z'
+            createdOn: '2023-03-17T18:47:35Z'
+            isArchived: false
+            isDraft: false
+            fieldData:
+              name: Pan-Galactic Gargle Blaster
+              slug: pan-galactic-gargle-blaster
+    docs: Information about an updated collection item
+  collection_item_deleted:
+    audiences: []
+    method: POST
+    display-name: Collection Item Deleted
+    headers: {}
+    payload: root.CollectionItemRemoved
+    examples:
+      - payload:
+          triggerType: collection_item_deleted
+          payload:
+            id: 66424365e972c886137a1cf1
+            siteId: 65427cf400e02b306eaa049c
+            workspaceId: 625860a7a6c16d624927122f
+            collectionId: 664243617fcc8b464b23c4ee
+            cmsLocaleId: 681442a144bb80bd00480fda
+            lastUpdated: '2025-05-28T04:44:33Z'
+            createdOn: '2025-05-28T04:27:12Z'
+            isArchived: false
+            isDraft: false
+            fieldData:
+              name: Anna Gunn
+              slug: anna-gunn
+              _locale: 681442a144bb80bd00480fda
+              _noSearch: false
+    docs: Information about a deleted collection item
+  collection_item_unpublished:
+    audiences: []
+    method: POST
+    display-name: Collection Item Unpublished
+    headers: {}
+    payload: root.CollectionItemUnpublished
+    examples:
+      - payload:
+          triggerType: collection_item_unpublished
+          payload:
+            id: 66424365e972c886137a1cf1
+            siteId: 65427cf400e02b306eaa049c
+            workspaceId: 625860a7a6c16d624927122f
+            collectionId: 664243617fcc8b464b23c4ee
+            cmsLocaleId: 681442a144bb80bd00480fda
+            lastUpdated: '2025-05-28T04:44:33Z'
+            createdOn: '2025-05-28T04:27:12Z'
+            isArchived: false
+            isDraft: false
+            fieldData:
+              name: Anna Gunn
+              slug: anna-gunn
+              _locale: 681442a144bb80bd00480fda
+              _noSearch: false
+    docs: Information about a collection item that was removed from the live site