Demo to preview the settings

Introduction

Get your Webflow site ID, retrieve collections, and collection items within one site at a time.

Prerequisites

  1. You must have the Webflow API Key.
Image without caption

How to set up

Retrieve your API key

This plugin is set up to work with only one site at a time, so you'll need to generate a site-specific API key and use this in the plugin settings area.
Open the site you wish to work work:
Image without caption
Select the Integrations tab, then scroll down to API access:
Image without caption
Your screen will look a little different from ours. Since we've already generated an API key for this site, the button is now grey instead of blue. Click this blue button and copy the API key to your clipboard.
Paste the API key into the first input in your plugin settings area. Make sure you use the word Bearer and a space character before the API key. The final value will follow the format below:
Bearer YOUR-API KEY-HERE
Image without caption
That's it! You're now ready to start using any of the API calls in this plugin for the site you've selected. Remember that if you want to work with another site, you'll need to get a new API for the new site and replace this value we just set.

Get Site

This API call normally returns a list of sites, but since we're working with only one site API key at a time, this will only return the one site at a time.

Set up the datasource

We're using a repeating group in our example. Make sure whatever element you use has the correct type of content set (List Site (Webflow)):
Image without caption

Set up the API call

Using the blue button from the screenshot above, we'll use a Display Data in List action to send the results of this API call to the repeating group we've set up.
Select "Get data from external API" from the list of data sources, then find Webflow - List Sites from the list of API providers
Select "Get data from external API" from the list of data sources, then find Webflow - List Sites from the list of API providers
That's it! Be sure to take note of the Site ID returned from this call as it is required in most of the following API calls in this plugin.

Publish Site

Set up the API call

In this example, we'll be making a quick API call to Publish a Site. Select Webflow - Publish Site from the list of plugin actions and associate it with whatever visual element you want:
Image without caption
Start by creating a form to collect the necessary path and parameter.
Image without caption
That's it!

Available Path (* indicates a required value)

site_id* - The ID of your Webflow site.

Available Parameter (* indicates a required value)

domains* - Comma-separated list of domains to publish.

List Collections

Set up the datasource

We're using a repeating group in our example with type of content set to "List Collection (Webflow)":
Image without caption

Set up the API call

Using the blue button from the screenshot above, we'll use a "Display Data in List" action to send the results of this API call to the repeating group we've set up.
Select "Get data from external API" from the list of data sources, then find Webflow - List Collections from the list of API providers
Select "Get data from external API" from the list of data sources, then find Webflow - List Collections from the list of API providers
Indicate the Site ID by typing it in manually or referencing another source, such as an input:
Image without caption
That's it!

Available Path (* indicates a required value)

site_id* - The ID of your Webflow site.

Get Collection

Set up the datasource

We're using a group in our example with the type of content set to "Get Collection (Webflow)":
Image without caption

Set up the API call

Using the blue button from the screenshot above, we'll use a "Display Data in group" action to send the results of this API call to the group we've set up.
Select "Get data from external API" from the list of data sources, then find Webflow - Get Collection from the list of API providers
Select "Get data from external API" from the list of data sources, then find Webflow - Get Collection from the list of API providers
Now map the inputs to the corresponding path:
Image without caption
That's it!

Available Path (* indicates a required value)

site_id* - The ID of your Webflow site.

List Items in Collection

Set up the datasource

We're using a repeating group in our example with the type of content set to "List Collection (Webflow)":
Image without caption

Set up the API call

Using the blue button from the screenshot above, we'll use a "Display Data in List" action to send the results of this API call to the repeating group we've set up.
Select "Get data from external API" from the list of data sources, then find Webflow - List Items in Collection from the list of API providers
Select "Get data from external API" from the list of data sources, then find Webflow - List Items in Collection from the list of API providers
Now map the inputs to the corresponding path:
Image without caption
That's it!

Available Path (* indicates a required value)

collection_id* - The ID of your Collection.

Get Single Item in Collection

Set up the datasource

We're using a group in our example with the type of content set to "Get Single Item in Collection (Webflow)":
Image without caption

Set up the API call

Using the blue button from the screenshot above, we'll use a "Display Data in group" action to send the results of this API call to the group we've set up.
Select "Get data from external API" from the list of data sources, then find Webflow - Get Single Item in Collection from the list of API providers
Select "Get data from external API" from the list of data sources, then find Webflow - Get Single Item in Collection from the list of API providers
Now map the inputs to the corresponding path:
Image without caption
That's it!

Available Path (* indicates a required value)

collection_id* - The ID of your Collection.
item_id* - The ID of your Item.
Image without caption

Changelogs

Update 26.06.23 - Version 2.1.0

  • updated description

Update 15.02.23 - Version 2.0.0

  • Removed List Domains call

Update 15.02.23 - Version 1.2.0

  • Updated calls, added ability to list domains for a site and publish, and new documentation

Update 28.03.20 - Version 1.1.0

  • Plugin description update.

Update 08.06.17 - Version 1.0.0

  • Initial release - Retrieve site info, collections and items.

Powered by Notaku