Sync new articles to Webflow

Byword's webflow integration allows you to sync your Byword articles with a Webflow collection. This means that, whenever you generate an article in Byword, it'll immediately be uploaded to your Webflow site.

Setting up the Webflow integration works in three stages:

Provide An API Key

When you first head to the Webflow integration page, you'll be prompted to enter your site's API key. The page contains instructions for how to find this, or alternatively you can use Webflow's own documentation.

Once you have your API key, enter it into the box and hit Verify.

Do bear in mind that Webflow will never show you your API key again once it's generated. That means you should take note of it, or be prepared to generate a new one (and reconfigure your Byword integration) if you ever need to.

Choose Your CMS Collection

Next, you'll be prompted to choose the CMS collection that you want to sync your articles to. For most sites, this will be whichever CMS collection corresponds to your blog posts.

Configure CMS Settings

Lastly, you'll be asked to configure your CMS settings. These settings control how Byword creates CMS items in your collection. Tailor them as is appropriate to your use case.

Live Site Status

By default, Byword posts your articles to your staging site, meaning that a visitor to your site won't be able to see your articles until they've been published inside of Webflow. Toggle this setting if you'd like to have your articles uploaded immediately upon generation.

Field Mapping

This is the most important part of your setup, as it's where you tell Byword which fields in your CMS are the most important.

Byword imports the article title to the default Name field in your CMS, meaning you don't have to configure anything here.

You do have to tell Byword which fields in your CMS correspond to:

  • The article body (which should be a rich text field in Webflow)

  • The article meta description (which should be any text field in Webflow)

  • The article image (which should be an image field in Webflow)

The first of these (article body) is a required field. After all, why would you want to sync with Webflow if you didn't want to send the article body! The other two fields (meta description and image) are both optional. You can sync them if you wish, but equally it's fine to leave them blank.

Once everything has been set up correctly, you should see a confirmation message at the bottom of your screen.

If you ever need to reconnect your site, or choose a different CMS collection, hit the Reset button at the top of your page.

Manual syncs

You can manually sync articles from Byword to your Webflow site. You can do this in two different ways:

  • Syncing one or more single articles To do this, head to My Articles, select the articles you'd like to sync, and press the Sync to Site button above the articles table.

  • Syncing a project Head to any project page inside of My Articles, and select the Webflow button at the top of the page (this may appear as Sync to Site if you have mutliple integrations enabled). Note that this will sync the entire project.

In order to use either of these methods, you'll have to have already set up a Webflow integration.

Do bear in mind that there is no way to pause or cancel a manual sync once started, and that the sync should take between 1 and 2 seconds per article.

Last updated