Skip to content

Webflow

Getting Started with Webflow

The Webflow modules allow you to monitor events, list, get, publish sites, or list, get, create, update and delete items, orders and other items in your Webflow account.

Prerequisites

  • A Webflow account

In order to use Webflow with Ibexa Connect, it is necessary to have a Webflow account. If you do not have one, you can create a Webflow account at webflow.com/dashboard/signup.

Caution

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Webflow to Ibexa Connect

To connect your Webflow account to Ibexa Connect follow the general instructions for Connecting to services.

After you click the Continue button, Ibexa Connect will redirect you to the Webflow website where you will be prompted to grant Ibexa Connect access to your account.

61d6ba668d4f8.png

Confirm the dialog by clicking the Authorize Application button.

Webhook

Watch Events

Triggers when a specified event in your Webflow account occurs.

Click the Add button to set up the webhook module.

61d6ba67deebc.png

Webhook Name Enter a name for the webhook. E.g. Site Published.
Site ID Select the site that you want to monitor for occurred events.
Trigger Type Select the event that will trigger the module.

Site

List Sites

Lists all sites in your Webflow account.

Limit Set the maximum number of sites Ibexa Connect will return during one execution cycle.

Get Site

Retrieves site details.

Site ID Map or select the site you want to retrieve details about.

Publish Site

Publishes an existing site.

Site ID

Select the site you want to publish.

Domain

Select the domain you want to publish the site on.

When the domain is not listed in the drop-down menu you can publish it on Webflow domain by entering your-site-name.webflow.io manually.

Collection

List Collection

Retrieves all collections form the specified site.

Site ID Select the site you want retrieve collections from.
Limit Set the maximum number of collections Ibexa Connect will return during one execution cycle.

Get Collection

Retrieves a collection's details.

Enter collection ID Select whether you want to select the collection from the menu or enter (map) the collection manually.
Collection ID Enter or map the Collection ID of the collection you want to retrieve details about.

Item

List Items

Retrieves items of the CMS collection.

Enter collection ID Select whether you want to select the collection from the menu or enter (map) the collection manually.
Collection ID Enter or map the Collection ID of the collection you want to retrieve items from.

Get Item

Retrieves item details.

Enter Item ID Select whether you want to select the item from the menu or enter (map) the collection manually.
Collection ID Enter or map the Collection ID that contains the items you want to retrieve.
Item ID Enter or map the Item ID of the item you want to retrieve details about.

Create Item

Creates a new item.

Site ID

Select or map the site that contains the collection you want to create an item for.

Collection ID

Enter or map the Collection ID of the collection you want to create an item for.

Fields

Fill desired fields.

Name: Enter the name of the item.

Slug: Define the item's slug - the URL structure of the item in your site.

Select whether to set the item as archived or/and as a draft.

Live

Select the Yes option to publish the item to the live site.

Update Item

Edits the item.

Site Select or map the site that contains the collection you want to create an item for.
Collection Enter or map the collection that contains the item you want to update.
Item Select or map the item you want to update.

Please find the descriptions of the fields in the Create Item section above.

Delete Item

Deletes an item.

Enter Item ID Select whether you want to select the item from the menu or enter (map) the collection manually.
Collection Enter or map the collection that contains the item you want to delete.
Item Select or map the item you want to delete.

Order

List Orders

Retrieves orders from the specified site.

Status Select the status of orders to be retrieved.
Limit Set the maximum number of orders Ibexa Connect will return during one execution cycle.

Get Order

Retrieves order details.

Site ID Enter (map) or select the site you want to retrieve the order from.
Order ID Enter (map) or select the order you want to retrieve details about.

Update Order

Allows you to change order details.

Site ID Enter (map) or select the site that contains the order you want to update.
Order ID Enter (map) or select the order you want to update.
Fields Fill the fields that should be updated.

Mark Order Fulfilled/Unfulfilled/Refunded

Updates an order’s status.

Site ID Enter (map) or select the site that contains the order which status you want to change.
Order ID Enter (map) or select the order which status you want to change.
Mark Order As Select the new status of the order.

Inventory

Get Item Inventory

Retrieves the current inventory levels for a particular SKU item.

Enter Item ID Select whether you want to select the item from the menu or enter (map) the collection manually.
Collection ID Enter or map the Collection ID that contains items you want to retrieve levels for.
Item ID Enter or map the Item ID of the item you want to retrieve levels for.

Update Item Inventory

Updates the current inventory levels for a particular SKU item.

Enter Item ID

Select whether you want to select the item from the menu or enter (map) the collection manually.

Collection ID

Enter or map the Collection ID that contains items you want to update levels for.

Item ID

Enter or map the Item ID of the item you want to update levels for.

Inventory Type

Select whether you have finite or infinite quantity of items in your inventory.

Quantity:

When the finite type is selected. Sets quantity to the entered value.

Update Quantity:

When the infinite type is selected. Adds this quantity to currently store quantity. Can be negative.

Make an API Call

Allows you to perform a custom API call.

URL

Enter a path relative to https://api.webflow.com/. E.g. /collections/5d70ff90c8ca5df72b43c89b/items where the sample number5d70ff90c8ca5df72b43c89b is the Collection ID of the collection you want to retrieve items from, according to the following endpoint description:/collections/:collection_id/items

For the list of available endpoints, refer to the Webflow API documentation.

Method

Select the HTTP method you want to use:

  • GET: to retrieve information for an entry.

  • POST: to create a new entry.

  • PUT: to update/replace an existing entry.

  • PATCH: to make a partial entry update.

  • DELETE: to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Items from the Collection

The following API call returns all items from the specified collection:

61d6ba6918482.png

Matches of the search can be found in the module's Output under Bundle > Body > items.

In our example, 5 items were returned:

61d6ba6a46526.png