webflow-api 3.1.4 → 3.2.1

package/.mock/definition/pages/scripts.yml

@@ -7,7 +7,9 @@ service:
     get-custom-code:
       path: /pages/{page_id}/custom_code
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:read
       docs: |
         Get all scripts applied to a page. 
 
@@ -45,14 +47,22 @@ service:
     upsert-custom-code:
       path: /pages/{page_id}/custom_code
       method: PUT
-      auth: true
-      docs: |
-        Apply scripts to a page.
+      auth:
+        - OAuth2:
+            - custom_code:write
+      docs: >
+        Apply registered scripts to a page. If you have multiple scripts your
+        App needs to apply or maintain on a page, ensure they are always
+        included in the request body for this endpoint. To remove individual
+        scripts, simply call this endpoint without the script in the request
+        body.
+
 
         <Note title="Script Registration">
           To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
         </Note>
 
+
         Required scope | `custom_code:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -106,13 +116,22 @@ service:
     delete-custom-code:
       path: /pages/{page_id}/custom_code
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:write
       docs: >
-        Delete a custom code block that the App created on a page.
+        Remove all scripts from a page applied by the App. This endpoint will
+        not remove scripts from the site's registered scripts.
+
+
+        To remove individual scripts applied by the App, use the [Add/Update
+        Custom
+        Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code)
+        endpoint.
 
 
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>
+        <Note>Access to this endpoint requires a bearer token obtained from an
+        [OAuth Code Grant Flow](/data/reference/oauth-app).</Note>
 
 
         Required scope | `custom_code:write`

package/.mock/definition/pages.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/pages
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - page:read
       docs: |
         List of all pages for a site.
 
@@ -24,9 +26,12 @@ 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)
           limit:
             type: optional<double>
             docs: 'Maximum number of records to be returned (max limit: 100)'
@@ -50,6 +55,8 @@ service:
             site_id: 580e63e98c9a982ac9b8b741
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               pages:
@@ -61,8 +68,9 @@ service:
                   lastUpdated: '2024-03-11T10:42:42Z'
                   archived: false
                   draft: false
-                  canBranch: true
-                  isBranch: false
+                  canBranch: false
+                  isBranch: true
+                  branchId: 68026fa68ef6dc744c75b833
                   seo:
                     title: The Ultimate Hitchhiker's Guide to the Galaxy
                     description: >-
@@ -110,7 +118,9 @@ service:
     get-metadata:
       path: /pages/{page_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - page:read
       docs: |
         Get metadata information for a single page.
 
@@ -127,9 +137,12 @@ 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)
       response:
         docs: Request was successful
         type: root.Page
@@ -155,8 +168,9 @@ service:
               lastUpdated: '2024-03-11T10:42:42Z'
               archived: false
               draft: false
-              canBranch: true
-              isBranch: false
+              canBranch: false
+              isBranch: true
+              branchId: 68026fa68ef6dc744c75b833
               seo:
                 title: The Ultimate Hitchhiker's Guide to the Galaxy
                 description: >-
@@ -174,14 +188,12 @@ service:
     update-page-settings:
       path: /pages/{page_id}
       method: PUT
-      auth: true
+      auth:
+        - OAuth2:
+            - page:write
       docs: |
         Update Page-level metadata, including SEO and Open Graph fields.
 
-        <Note>
-          Note: When updating Page Metadata in secondary locales, you may only add `slug` to the request if your Site has the [Advanced or Enterprise Localization](https://webflow.com/localization) add-on.
-        </Note>
-
         Required scope | `pages:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -191,14 +203,37 @@ service:
           docs: Unique identifier for a Page
       display-name: Update Page Metadata
       request:
-        body: root.Page
+        name: PageMetadataWrite
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
-        name: UpdatePageSettingsRequest
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
+        body:
+          properties:
+            title:
+              type: optional<string>
+              docs: Title for the page
+            slug:
+              type: optional<string>
+              docs: >
+                Slug for the page. 
+
+
+
+                **Note:** Updating slugs in secondary locales is only supported
+                in <a href="https://webflow.com/localization">Advanced and
+                Enterprise localization add-on plans.</a>
+            seo:
+              type: optional<PageMetadataWriteSeo>
+              docs: SEO-related fields for the Page
+            openGraph:
+              type: optional<PageMetadataWriteOpenGraph>
+              docs: Open Graph fields for the Page
         content-type: application/json
       response:
         docs: Request was successful
@@ -216,16 +251,8 @@ service:
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
           request:
-            id: 6596da6045e56dee495bcbba
-            siteId: 6258612d1ee792848f805dcf
             title: Guide to the Galaxy
             slug: guide-to-the-galaxy
-            createdOn: '2024-03-11T10:42:00Z'
-            lastUpdated: '2024-03-11T10:42:42Z'
-            archived: false
-            draft: false
-            canBranch: true
-            isBranch: false
             seo:
               title: The Ultimate Hitchhiker's Guide to the Galaxy
               description: >-
@@ -238,8 +265,6 @@ service:
                 Dive deep into the mysteries of the universe with your guide to
                 everything galactic.
               descriptionCopied: false
-            localeId: 653fd9af6a07fc9cfd7a5e57
-            publishedPath: /en-us/guide-to-the-galaxy
           response:
             body:
               id: 6596da6045e56dee495bcbba
@@ -250,8 +275,9 @@ service:
               lastUpdated: '2024-03-11T10:42:42Z'
               archived: false
               draft: false
-              canBranch: true
-              isBranch: false
+              canBranch: false
+              isBranch: true
+              branchId: 68026fa68ef6dc744c75b833
               seo:
                 title: The Ultimate Hitchhiker's Guide to the Galaxy
                 description: >-
@@ -269,24 +295,13 @@ service:
     get-content:
       path: /pages/{page_id}/dom
       method: GET
-      auth: true
-      docs: >
-        Get content from a static page. This includes text nodes, image nodes,
-        select nodes, text input nodes, submit button nodes, and component
-        instances with [property
-        overrides](https://help.webflow.com/hc/en-us/articles/33961219350547-Component-properties#how-to-modify-property-values-on-component-instances).
-
-
-        To retrieve the static content of a component instance, use the [Get
-        Component
-        Content](/data/reference/pages-and-components/components/get-content)
-        endpoint.
-
-
-        <Note>If you do not include a `localeId` in your request, the response
-        will return any content that can be localized from the Primary
-        locale.</Note>
+      auth:
+        - OAuth2:
+            - page:read
+      docs: |
+        Get text and component instance content from a static page.
 
+        <Badge intent="info">Localization</Badge> 
 
         Required scope | `pages:read`
       source:
@@ -301,9 +316,12 @@ 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)
           limit:
             type: optional<double>
             docs: 'Maximum number of records to be returned (max limit: 100)'
@@ -328,9 +346,12 @@ service:
             page_id: 63c720f9347c2139b248e552
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               pageId: 658205daa3e8206a523b5ad4
+              branchId: 68026fa68ef6dc744c75b833
               nodes:
                 - id: id
                   text: {}
@@ -377,7 +398,9 @@ service:
     update-static-content:
       path: /pages/{page_id}/dom
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - page:write
       docs: >
         This endpoint updates content on a static page in **secondary locales**.
         It supports updating up to 1000 nodes in a single request.
@@ -387,12 +410,17 @@ service:
 
         1. Use the [get page
         content](/data/reference/pages-and-components/pages/get-content)
-        endpoint to identify available content nodes and their types
+        endpoint to identify available content nodes and their types.
 
         2. If the page has component instances, retrieve the component'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>
@@ -472,15 +500,47 @@ service:
   display-name: Pages
 docs: Pages are the pages in your Webflow site.
 types:
+  PageMetadataWriteSeo:
+    docs: SEO-related fields for the Page
+    properties:
+      title:
+        type: optional<string>
+        docs: The Page title shown in search engine results
+      description:
+        type: optional<string>
+        docs: The Page description shown in search engine results
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  PageMetadataWriteOpenGraph:
+    docs: Open Graph fields for the Page
+    properties:
+      title:
+        type: optional<string>
+        docs: The title supplied to Open Graph annotations
+      titleCopied:
+        type: optional<boolean>
+        docs: Indicates the Open Graph title was copied from the SEO title
+      description:
+        type: optional<string>
+        docs: The description supplied to Open Graph annotations
+      descriptionCopied:
+        type: optional<boolean>
+        docs: >-
+          Indicates the Open Graph description was copied from the SEO
+          description
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
   PageDomWriteNodesItem:
     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
@@ -491,3 +551,52 @@ types:
         type: list<string>
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
+webhooks:
+  page_created:
+    audiences: []
+    method: POST
+    display-name: Page Created
+    headers: {}
+    payload: root.PageCreatedWebhook
+    examples:
+      - payload:
+          triggerType: page_created
+          payload:
+            siteId: 65427cf400e02b306eaa049c
+            pageId: 66a3cfb276641574f5d58311
+            pageTitle: Heart of Gold Specs
+            createdOn: '2024-07-26T16:32:50Z'
+            publishedPath: /blog/earth
+    docs: Information about a new pages
+  page_metadata_updated:
+    audiences: []
+    method: POST
+    display-name: Page Metadata Updated
+    headers: {}
+    payload: root.PageMetadataUpdatedWebhook
+    examples:
+      - payload:
+          triggerType: page_metadata_updated
+          payload:
+            siteId: 65427cf400e02b306eaa049c
+            pageId: 66a3cfb276641574f5d58311
+            pageTitle: Heart of Gold Specs
+            lastUpdated: '2024-07-26T16:32:50Z'
+            publishedPath: /blog/earth
+    docs: Information about a page's updated metadata and/or settings
+  page_deleted:
+    audiences: []
+    method: POST
+    display-name: Page Deleted
+    headers: {}
+    payload: root.PageDeletedWebhook
+    examples:
+      - payload:
+          triggerType: page_deleted
+          payload:
+            siteId: 65427cf400e02b306eaa049c
+            pageId: 66a3cfb276641574f5d58311
+            pageTitle: Heart of Gold Specs
+            deletedOn: '2024-07-26T16:32:50Z'
+            publishedPath: /blog/earth
+    docs: Information about a page that was deleted