Webflow

Webflow module for RobinPath.

Package: @robinpath/webflow | Category: Cms | Type: Integration

Authentication

webflow.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the webflow module when you need to:

• listSites -- Use webflow.listSites to perform this operation
• getSite -- Use webflow.getSite to perform this operation
• publishSite -- Use webflow.publishSite to perform this operation
• listCollections -- Use webflow.listCollections to perform this operation
• getCollection -- Use webflow.getCollection to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure webflow credentials.	object
listSites	listSites	object
getSite	getSite	object
publishSite	publishSite	object
listCollections	listCollections	object
getCollection	getCollection	object
listCollectionItems	listCollectionItems	object
getCollectionItem	getCollectionItem	object
createCollectionItem	createCollectionItem	object
updateCollectionItem	updateCollectionItem	object
deleteCollectionItem	deleteCollectionItem	object
publishCollectionItems	publishCollectionItems	object
listFormSubmissions	listFormSubmissions	object
listDomains	listDomains	object
getUser	getUser	object
listUsers	listUsers	object
listOrders	listOrders	object
getOrder	getOrder	object
updateOrder	updateOrder	object

Functions

setCredentials

Configure webflow credentials.

Module: webflow | Returns: object -- API response.

webflow.setCredentials

Parameter	Type	Required	Description
accessToken	string	Yes	accessToken

---

listSites

listSites

Module: webflow | Returns: object -- API response.

webflow.listSites

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getSite

getSite

Module: webflow | Returns: object -- API response.

webflow.getSite

Parameter	Type	Required	Description
input	string	No	Input parameter

---

publishSite

publishSite

Module: webflow | Returns: object -- API response.

webflow.publishSite

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listCollections

listCollections

Module: webflow | Returns: object -- API response.

webflow.listCollections

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getCollection

getCollection

Module: webflow | Returns: object -- API response.

webflow.getCollection

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listCollectionItems

listCollectionItems

Module: webflow | Returns: object -- API response.

webflow.listCollectionItems

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getCollectionItem

getCollectionItem

Module: webflow | Returns: object -- API response.

webflow.getCollectionItem

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createCollectionItem

createCollectionItem

Module: webflow | Returns: object -- API response.

webflow.createCollectionItem

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateCollectionItem

updateCollectionItem

Module: webflow | Returns: object -- API response.

webflow.updateCollectionItem

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteCollectionItem

deleteCollectionItem

Module: webflow | Returns: object -- API response.

webflow.deleteCollectionItem

Parameter	Type	Required	Description
input	string	No	Input parameter

---

publishCollectionItems

publishCollectionItems

Module: webflow | Returns: object -- API response.

webflow.publishCollectionItems

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listFormSubmissions

listFormSubmissions

Module: webflow | Returns: object -- API response.

webflow.listFormSubmissions

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listDomains

listDomains

Module: webflow | Returns: object -- API response.

webflow.listDomains

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getUser

getUser

Module: webflow | Returns: object -- API response.

webflow.getUser

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listUsers

listUsers

Module: webflow | Returns: object -- API response.

webflow.listUsers

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listOrders

listOrders

Module: webflow | Returns: object -- API response.

webflow.listOrders

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getOrder

getOrder

Module: webflow | Returns: object -- API response.

webflow.getOrder

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateOrder

updateOrder

Module: webflow | Returns: object -- API response.

webflow.updateOrder

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Webflow API error (${res.status}): ${t}	Check the error message for details
webflow.setCredentials requires accessToken.	Check the error message for details
webflow.publishSite requires an ID.	Check the error message for details
webflow.updateCollectionItem requires an ID.	Check the error message for details
webflow.deleteCollectionItem requires an ID.	Check the error message for details
webflow.publishCollectionItems requires an ID.	Check the error message for details
webflow.updateOrder requires an ID.	Check the error message for details
Webflow: "..." not configured. Call webflow.setCredentials first.	Check the error message for details

@desc "List sites and validate result"
do
  set $result as webflow.listSites
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Sites

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  webflow.setCredentials $token
enddo

@desc "List sites and iterate results"
do
  set $result as webflow.listSites
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createCollectionItem

Create a new resource and capture the result.

@desc "Setup authentication"
do
  webflow.setCredentials $token
enddo

@desc "Create collection item"
do
  set $result as webflow.createCollectionItem
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  webflow.setCredentials $token
enddo

@desc "Create collection item and update collection item"
do
  set $created as webflow.createCollectionItem
  # Update the created item
  webflow.updateCollectionItem
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  webflow.setCredentials $token
enddo

@desc "List sites and create collection item"
do
  set $existing as webflow.listSites
  if $existing == null
    webflow.createCollectionItem
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Webflow workflow

Chain multiple webflow operations together.

@desc "Setup authentication"
do
  webflow.setCredentials $token
enddo

@desc "List sites, get site, and more"
do
  set $r_listSites as webflow.listSites
  set $r_getSite as webflow.getSite
  set $r_publishSite as webflow.publishSite
  print "All operations complete"
enddo

6. Safe listSites with validation

Check results before proceeding.

@desc "Setup authentication"
do
  webflow.setCredentials $token
enddo

@desc "List sites and validate result"
do
  set $result as webflow.listSites
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• json -- JSON module for complementary functionality