Skip to main content

Webflow Data API Data Source

The Webflow Data API connector enables you to ingest site metadata, page content, CMS collections and items, reusable components, products, SKUs, and e-commerce orders from Webflow into any downstream system. Follow the instructions below to create a new data flow that ingests data from a Webflow Data API source in Nexla.
webflow_api.png

Webflow Data API

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Webflow Data API connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Webflow Data API instance, and click Next; or, create a new Webflow Data API credential for use in this flow.

  3. In Nexla, Webflow Data API data sources can be created using pre-built endpoint templates, which expedite source setup for common Webflow Data API endpoints. Each template is designed specifically for the corresponding Webflow Data API endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Webflow Data API sources can also be configured manually, allowing you to ingest data from Webflow Data API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Webflow Data API endpoints. Each template is designed specifically for the corresponding Webflow Data API endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

Get Authorization User Info

Retrieves information about the Webflow user who authorized the current OAuth token, including user ID, email address, and display name. Use this endpoint to verify which user account the credential is connected to or to log the identity of the authorizing user for auditing purposes.

  • No additional parameters are required for this endpoint. Selecting it and clicking Test will immediately return the user profile associated with the OAuth token used in the credential.

This endpoint calls GET /token/authorized_by on the Webflow Data API. For full details, see the Authorized User reference.

Get Authorization Info

Retrieves metadata about the current OAuth token, including its granted scopes, expiration time, and the application it was issued to. Use this endpoint to inspect the permissions and validity of the credential without making data-level API calls.

  • No additional parameters are required. The endpoint introspects the token used by the current Nexla credential and returns its metadata.

This endpoint calls GET /token/introspect. Refer to the Token Introspect reference for the full response schema.

List Sites

Retrieves all Webflow sites accessible to the authorized user. Use this endpoint to enumerate available sites and obtain site IDs needed for other endpoints such as List Pages, List Collections, and List Products & SKUs.

  • No additional parameters are required. The response returns an array of site objects, each containing the site ID, display name, short name, preview URL, and last-published timestamp.

Site IDs returned by this endpoint are required as input for all site-scoped endpoints. Run this endpoint first if you do not already know your site ID.

Get Site

Retrieves detailed metadata for a single Webflow site by its ID. Use this endpoint when you need configuration details for a specific site, such as its default domain, locale settings, or enabled features.

  • Enter the unique identifier of the site in the Site ID field. Site IDs can be obtained from the List Sites endpoint or from the Webflow dashboard under Site Settings > General.

The Site ID is a 24-character alphanumeric string (for example, 6114281f4f7804f97fce8e2b). It is distinct from the site's short name or custom domain.

List Pages

Retrieves a paginated list of all pages for a specific Webflow site, optionally filtered by locale. Use this endpoint to enumerate the pages published on a site, obtain page IDs for downstream operations, or audit page structure across locales.

  • Enter the unique identifier of the site in the Site ID field. This is required. Use the List Sites endpoint if you need to look up the Site ID.
  • Optionally, enter a locale identifier in the Locale ID field to filter results to pages associated with a specific locale. Leave this field blank to return pages for the site's default locale. Locale IDs can be found in the site's locale settings in the Webflow dashboard.

This endpoint supports pagination and will automatically fetch all pages using offset-based pagination (up to 100 records per page). For sites with many pages, all results will be retrieved across multiple requests.

Get Page Metadata

Retrieves metadata for a single Webflow page, such as its title, slug, SEO settings, open graph settings, and locale configuration. Use this endpoint when you need structured page-level metadata for content auditing, SEO analysis, or synchronization with external CMS systems.

  • Enter the unique identifier of the page in the Page ID field. This is required. Page IDs can be obtained from the List Pages endpoint.
  • Optionally, enter a locale identifier in the Locale ID field to retrieve metadata for a specific locale variant of the page. Leave this field blank for the default locale.

Get Page Content

Retrieves the DOM (Document Object Model) node tree for a specific Webflow page, returned as a paginated list of node objects. Use this endpoint to extract the full content structure of a page for content migration, localization workflows, or programmatic content management.

  • Enter the unique identifier of the page in the Page ID field. This is required. Page IDs can be obtained from the List Pages endpoint.
  • Optionally, enter a locale identifier in the Locale ID field to retrieve DOM content for a specific locale version of the page. Leave blank for the default locale.

Each node in the response represents an element in the page's DOM tree and includes the node ID, type, text content (if applicable), and child nodes. This endpoint supports pagination, returning up to 100 nodes per page.

List Components

Retrieves a paginated list of reusable components defined in a Webflow site, optionally filtered by branch. Components in Webflow are design elements that can be reused across multiple pages. Use this endpoint to audit components, synchronize component definitions with external design systems, or manage component content programmatically.

  • Enter the unique identifier of the site in the Site ID field. This is required.
  • Optionally, enter a branch identifier in the Branch ID field to filter components to a specific Webflow branch. Leave blank to retrieve components from the default (main) branch.

Webflow branches allow teams to work on site changes in isolation before publishing. If your workspace uses branching, use the Branch ID field to target the correct branch.

List Collections

Retrieves all CMS collections defined for a Webflow site. Collections are the structured content schemas in the Webflow CMS (for example, Blog Posts, Team Members, or Products). Use this endpoint to discover available collections and obtain collection IDs needed for item-level operations.

  • Enter the unique identifier of the site in the Site ID field. This is required. Use the List Sites endpoint to look up Site IDs.

Each collection returned includes the collection ID, display name, slug, and field schema. Collection IDs are required for all collection-item endpoints such as List Collection Items and Get Collection Item.

List Collection Items

Retrieves a paginated list of staged (draft and published) items from a specific CMS collection. Use this endpoint to sync CMS content to an external system, audit collection data, or feed content into a downstream transformation pipeline.

  • Enter the unique identifier of the CMS collection in the Collection ID field. This is required. Collection IDs can be obtained from the List Collections endpoint.
  • Optionally, enter a CMS locale identifier in the CMS Locale ID field to filter items to a specific language or locale. Leave blank to retrieve items in the site's primary locale.

This endpoint returns staged items, which include both published items and items that have been saved but not yet published. To retrieve only currently published items, use the List Live Collection Items endpoint instead.

Get Collection Item

Retrieves a single staged item from a CMS collection by its item ID. Use this endpoint when you need the complete field data for a specific CMS record, such as fetching a particular blog post or product entry for inspection or downstream processing.

  • Enter the unique identifier of the collection in the Collection ID field. This is required.
  • Enter the unique identifier of the item in the Item ID field. This is required. Item IDs can be obtained from the List Collection Items endpoint.
  • Optionally, enter a CMS locale identifier in the CMS Locale ID field to retrieve the item's content in a specific locale.

List Live Collection Items

Retrieves a paginated list of currently published (live) items from a CMS collection. Use this endpoint when you need to work specifically with content that is live on the site—for example, to sync live product listings or published blog posts to an external analytics or search platform.

  • Enter the unique identifier of the CMS collection in the Collection ID field. This is required.
  • Optionally, enter a CMS locale identifier in the CMS Locale ID field to filter live items by locale.

Unlike List Collection Items, this endpoint returns only items that have been published and are currently live on the Webflow site. Draft or staged items are excluded.

Get Live Collection Item

Retrieves a single published (live) item from a CMS collection by its item ID. Use this endpoint when you need the live field values for a specific CMS record—for example, to verify published content or ingest a specific live item into a downstream system.

  • Enter the unique identifier of the collection in the Collection ID field. This is required.
  • Enter the unique identifier of the item in the Item ID field. This is required.
  • Optionally, enter a CMS locale identifier in the CMS Locale ID field to retrieve the live item in a specific locale.

List Products & SKUs

Retrieves a paginated list of all products and their associated SKUs for a Webflow e-commerce site. Use this endpoint to sync your Webflow product catalog with an external inventory management system, ERP, or analytics platform.

  • Enter the unique identifier of the site in the Site ID field. This is required. The site must have e-commerce enabled. Use the List Sites endpoint to obtain the Site ID.

In Webflow's e-commerce model, a Product represents the top-level item (for example, a T-shirt), while SKUs represent individual purchasable variants of that product (for example, size Small, color Blue). Each product in the response includes a nested array of its SKUs.

Get Product and SKUs

Retrieves the full details and all SKU variants for a single product. Use this endpoint when you need complete product and variant information for a specific item—for example, to sync a single product's data to an external fulfillment or pricing system.

  • Enter the unique identifier of the site in the Site ID field. This is required.
  • Enter the unique identifier of the product in the Product ID field. This is required. Product IDs can be obtained from the List Products & SKUs endpoint.

List Orders

Retrieves a paginated list of e-commerce orders for a Webflow site, optionally filtered by order status. Use this endpoint to sync order data to an external fulfillment system, financial reporting tool, or customer support platform.

  • Enter the unique identifier of the site in the Site ID field. This is required.

  • Optionally, select an order status in the Status field to filter results. Available status values are:

    • All Orders (blank) — Returns orders in all statuses
    • Pending — Orders that have been placed but not yet fulfilled
    • Fulfilled — Orders that have been fulfilled and shipped
    • Refunded — Orders that have been refunded

Leave the Status field blank to retrieve all orders regardless of status. This is the recommended approach when syncing order data to an external system for the first time.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Webflow Data API data sources can be manually configured to ingest data from any valid Webflow Data API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Webflow Data API sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Webflow Data API from the Method pulldown menu. The Webflow Data API uses:

    • GET: For all data retrieval operations (listing sites, pages, collections, items, products, and orders)
    • POST: For creating resources and triggering actions (used in destination flows)
    • PATCH: For partial updates to existing resources (used in destination flows)

API Endpoint URL​

  1. Enter the URL of the Webflow Data API endpoint from which this source will fetch data in the Set API URL field. All Webflow Data API v2 endpoints begin with https://api.webflow.com/v2.

    Common URL patterns include:

    • Sites: https://api.webflow.com/v2/sites
    • Pages for a site: https://api.webflow.com/v2/sites/{site_id}/pages
    • Collection items: https://api.webflow.com/v2/collections/{collection_id}/items
    • Products: https://api.webflow.com/v2/sites/{site_id}/products
    • Orders: https://api.webflow.com/v2/sites/{site_id}/orders

Replace {site_id} and {collection_id} with the actual IDs for your Webflow site and collection. IDs are 24-character alphanumeric strings available from the List Sites and List Collections endpoint templates or from the Webflow dashboard URL.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are useful for Webflow API calls that accept date range query parameters, such as filtering orders by creation date.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when building Webflow sources that iterate over a list of site IDs or collection IDs retrieved from another Nexla source.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the Webflow API endpoint is needed, you can designate the relevant portion of the response by specifying the path to that data. Most Webflow Data API list endpoints wrap the result array in a named property (for example, sites, pages, collections, items, products, or orders).

For example, the GET /v2/sites response returns {"sites": [...]}. To treat each site as a separate record, enter $.sites[*] as the Path to Data.

Specifying the correct Path to Data is important for Webflow API responses, since the result arrays are always nested under a named key. Without this setting, Nexla will treat the entire response object as a single record rather than expanding the array into individual records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (for example, $.items[*] for collection items or $.orders[*] for orders).
    Path to Data Examples for Webflow:

    Common paths for Webflow API responses include $.sites[*] for sites, $.pages[*] for pages, $.collections[*] for collections, $.items[*] for collection items, $.products[*] for products, and $.orders[*] for orders.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record.

For example, the Webflow GET /v2/collections/{collection_id}/items response includes a pagination object at the top level alongside the items array. If you have specified $.items[*] as the Path to Data, you can specify $.pagination as the Metadata path to attach pagination context to each item record.

Metadata paths are useful for preserving Webflow API response context such as total item counts or pagination cursors that apply to the full result set.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field. For JSON responses, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (for example, header1:value1,header2:value2). The Webflow Data API v2 may require an accept-version header for specific version targeting in some scenarios.

    You do not need to include the Authorization header—Nexla automatically injects the OAuth Bearer token from your credential into every request. Common headers like Content-Type and Accept are also handled automatically.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Webflow Data API data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.