> For the complete documentation index, see [llms.txt](https://docs.planetcrust.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.planetcrust.com/human-connections/webflow/webflow.md).

# Webflow

<p align="center"><a class="button primary" data-icon="circle-caret-right">Try @Human</a><a class="button primary" data-icon="check">Buy @Human Subscription</a><a class="button primary" data-icon="comments">Join @Human Community</a></p>

<figure><img src="/files/F56qRpZiclUvQSZrUeBI" alt="" width="375"><figcaption></figcaption></figure>

<h3 align="center">Put Webflow to Work with @Human Automations and @Human Agents</h3>

<p align="center">The Webflow Connection documents all Triggers, Actions and Query Operations available for creating automations via the Webflow API.</p>

{% embed url="<https://www.youtube.com/watch?v=CyuUuaBSZzA>" %}

#### What can you do with the Webflow Connection?

* Connect to the Webflow API in a few clicks
* Use the related Webflow Operations (see below) in @Human Automations or @Human Agents

### Related Operations

#### Trigger Operations

**Site Published**

Triggers on: sites/site\_published

Triggered when a site is published in Webflow.

**Collection Created**

Triggers on: collections/collection\_created

Triggered when a new collection is created in Webflow.

**Item Created**

Triggers on: items/item\_created

Triggered when a new item is created within a collection in Webflow.

**Item Updated**

Triggers on: items/item\_updated

Triggered when an existing item is updated within a collection in Webflow.

#### Action Operations

[Action: Create Item](/human-connections/webflow/webflow/action-create-a-project.md)

[Action: Fulfill Order](/human-connections/webflow/webflow/action-fulfill-order.md)

[Action: Update Live Item](/human-connections/webflow/webflow/action-update-live-item.md)

[Action: API Request](/human-connections/webflow/webflow/action-api-request.md)

#### Query Operations

Example link

### Related Automations

Example link

### Obtaining Access Credentials <a href="#obtaining-access-credentials" id="obtaining-access-credentials"></a>

To obtain a **System-to-System Personal Access Token (PAT)** for **Webflow**, follow these steps:

#### **Prerequisites**

* A **Webflow account** (free or paid).
* **Admin/Owner access** to the target Workspace (if generating a token for a team site).

#### **Steps to Generate a PAT in Webflow**

1. **Log in** to your [Webflow Dashboard](https://webflow.com/dashboard).
2. **Go to Workspace Settings**:
   * Click your **profile icon** (top-right) → **"Settings"**.
   * Select the relevant **Workspace** (if managing multiple teams).
3. **Navigate to "API Access"**:
   * In the left sidebar, click **"API Access"** under the Workspace settings.
4. **Generate a New Token**:
   * Click **"Generate new token"**.
   * Provide a **name** (e.g., "System Integration") and **optional description**.
   * Select **scopes/permissions** (e.g., `sites:read`, `sites:write`, `collections:read`). *(Choose minimal required scopes for security.)*
5. **Create Token**:
   * Click **"Generate token"**.
   * **Copy the token immediately** (it won’t be shown again). *(Store it securely—treat it like a password.)*

### Configuring Webhooks

1. **Log in** to your [Webflow Dashboard](https://webflow.com/dashboard).
2. **Select Target Site**: Click on the site you wish to configure.
3. **Navigate to Site Settings**: Click the **Settings icon** (gear) or navigate to **Site Settings**.
4. **Access Apps & Integrations**: Select the **"Apps & Integrations"** tab.
5. **Locate Webhooks**: Scroll down to the **Webhooks** section.
6. **Add Webhook**: Click the **"Add webhook"** button.
7. **Configure Webhook Details**:
   * **Trigger Type**: Choose the desired event (e.g., `Form Submission`, `Site Publish`).
   * **Destination URL**: Enter the URL where the payload should be sent.
   * **API Version**: Select the latest API version.
8. **Finalize**: Click **"Add webhook"** to save.

### Code (Apache v2.0): Service Connectivity and Metadata

```
{
  "handle": "webflow",
  "status": "active",
  "meta": {
    "short": "Webflow",
    "description": "Connect to Webflow to manage sites, collections, and items.",
    "icon": "webflow",
    "tags": ["cms", "website", "design"]
  },
  "service": {
    "baseURL": {
      "value": "https://api.webflow.com"
    },
    "protocol": "https",
    "contentType": "application/json",
    "headers": {
      "Accept": {
        "value": "application/json"
      },
      "Content-Type": {
        "value": "application/json"
      }
    },
    "auth": {
      "method": "api_token",
      "params": {
        "apiToken": {
          "token": {
            "value": "{{apiToken}}",
            "placeholders": [
              {
                "name": "apiToken",
                "type": "String",
                "description": "Webflow API token",
                "required": true
              }
            ]
          },
          "headerName": {
            "value": "Authorization",
            "placeholders": []
          }
        }
      }
    }
  }
}

```

### Code (Apache v2.0): List of External Resources and Internal Mapping

```
[
  {
    "handle": "sites",
    "meta": {
      "short": "Sites",
      "description": "Manage Webflow sites, including site settings and publishing."
    },
    "endpoint": {
      "value": "/sites",
      "placeholders": []
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "_id"
        ],
        "meta": {
          "description": "Unique identifier for the site"
        }
      },
      {
        "name": "name",
        "type": "String",
        "selector": [
          "name"
        ],
        "meta": {
          "description": "Name of the site"
        }
      },
      {
        "name": "createdOn",
        "type": "String",
        "selector": [
          "createdOn"
        ],
        "meta": {
          "description": "Date when the site was created"
        }
      },
      {
        "name": "lastPublished",
        "type": "String",
        "selector": [
          "lastPublished"
        ],
        "meta": {
          "description": "Date when the site was last published"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Site ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "create": {
        "method": "POST",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"name\": \"{{name}}\"}",
          "placeholders": [
            {
              "name": "name",
              "type": "String",
              "description": "Name of the new site",
              "required": true
            }
          ]
        }
      },
      "update": {
        "method": "PUT",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Site ID",
              "required": true
            }
          ]
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"name\": \"{{name}}\"}",
          "placeholders": [
            {
              "name": "name",
              "type": "String",
              "description": "Updated name of the site",
              "required": false
            }
          ]
        }
      },
      "delete": {
        "method": "DELETE",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Site ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    },
    "webhooks": [
      {
        "event": "site_published",
        "path": "/webhooks/webflow/site-published",
        "payload": [
          {
            "name": "siteId",
            "type": "String",
            "selector": [
              "siteId"
            ],
            "meta": {
              "description": "ID of the published site"
            }
          },
          {
            "name": "publishedOn",
            "type": "String",
            "selector": [
              "publishedOn"
            ],
            "meta": {
              "description": "Date when the site was published"
            }
          }
        ]
      }
    ]
  },
  {
    "handle": "collections",
    "meta": {
      "short": "Collections",
      "description": "Manage Webflow collections, including collection items."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/collections",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "_id"
        ],
        "meta": {
          "description": "Unique identifier for the collection"
        }
      },
      {
        "name": "name",
        "type": "String",
        "selector": [
          "name"
        ],
        "meta": {
          "description": "Name of the collection"
        }
      },
      {
        "name": "slug",
        "type": "String",
        "selector": [
          "slug"
        ],
        "meta": {
          "description": "URL slug for the collection"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Collection ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "create": {
        "method": "POST",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"name\": \"{{name}}\", \"slug\": \"{{slug}}\"}",
          "placeholders": [
            {
              "name": "name",
              "type": "String",
              "description": "Name of the new collection",
              "required": true
            },
            {
              "name": "slug",
              "type": "String",
              "description": "URL slug for the new collection",
              "required": true
            }
          ]
        }
      },
      "update": {
        "method": "PUT",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Collection ID",
              "required": true
            }
          ]
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"name\": \"{{name}}\", \"slug\": \"{{slug}}\"}",
          "placeholders": [
            {
              "name": "name",
              "type": "String",
              "description": "Updated name of the collection",
              "required": false
            },
            {
              "name": "slug",
              "type": "String",
              "description": "Updated URL slug for the collection",
              "required": false
            }
          ]
        }
      },
      "delete": {
        "method": "DELETE",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Collection ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    },
    "webhooks": [
      {
        "event": "collection_created",
        "path": "/webhooks/webflow/collection-created",
        "payload": [
          {
            "name": "collectionId",
            "type": "String",
            "selector": [
              "collectionId"
            ],
            "meta": {
              "description": "ID of the created collection"
            }
          },
          {
            "name": "siteId",
            "type": "String",
            "selector": [
              "siteId"
            ],
            "meta": {
              "description": "ID of the site where the collection was created"
            }
          }
        ]
      }
    ]
  },
  {
    "handle": "items",
    "meta": {
      "short": "Items",
      "description": "Manage items within Webflow collections."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/collections/{{collectionId}}/items",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        },
        {
          "name": "collectionId",
          "type": "String",
          "description": "Collection ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "_id"
        ],
        "meta": {
          "description": "Unique identifier for the item"
        }
      },
      {
        "name": "name",
        "type": "String",
        "selector": [
          "fieldData",
          "name"
        ],
        "meta": {
          "description": "Name of the item"
        }
      },
      {
        "name": "slug",
        "type": "String",
        "selector": [
          "fieldData",
          "slug"
        ],
        "meta": {
          "description": "URL slug for the item"
        }
      },
      {
        "name": "createdOn",
        "type": "String",
        "selector": [
          "createdOn"
        ],
        "meta": {
          "description": "Date when the item was created"
        }
      },
      {
        "name": "updatedOn",
        "type": "String",
        "selector": [
          "updatedOn"
        ],
        "meta": {
          "description": "Date when the item was last updated"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Item ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "create": {
        "method": "POST",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"fieldData\": {\"name\": \"{{name}}\", \"slug\": \"{{slug}}\"}}",
          "placeholders": [
            {
              "name": "name",
              "type": "String",
              "description": "Name of the new item",
              "required": true
            },
            {
              "name": "slug",
              "type": "String",
              "description": "URL slug for the new item",
              "required": true
            }
          ]
        }
      },
      "update": {
        "method": "PUT",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Item ID",
              "required": true
            }
          ]
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"fieldData\": {\"name\": \"{{name}}\", \"slug\": \"{{slug}}\"}}",
          "placeholders": [
            {
              "name": "name",
              "type": "String",
              "description": "Updated name of the item",
              "required": false
            },
            {
              "name": "slug",
              "type": "String",
              "description": "Updated URL slug for the item",
              "required": false
            }
          ]
        }
      },
      "delete": {
        "method": "DELETE",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Item ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    },
    "webhooks": [
      {
        "event": "item_created",
        "path": "/webhooks/webflow/item-created",
        "payload": [
          {
            "name": "itemId",
            "type": "String",
            "selector": [
              "itemId"
            ],
            "meta": {
              "description": "ID of the created item"
            }
          },
          {
            "name": "collectionId",
            "type": "String",
            "selector": [
              "collectionId"
            ],
            "meta": {
              "description": "ID of the collection where the item was created"
            }
          },
          {
            "name": "siteId",
            "type": "String",
            "selector": [
              "siteId"
            ],
            "meta": {
              "description": "ID of the site where the item was created"
            }
          }
        ]
      },
      {
        "event": "item_updated",
        "path": "/webhooks/webflow/item-updated",
        "payload": [
          {
            "name": "itemId",
            "type": "String",
            "selector": [
              "itemId"
            ],
            "meta": {
              "description": "ID of the updated item"
            }
          },
          {
            "name": "collectionId",
            "type": "String",
            "selector": [
              "collectionId"
            ],
            "meta": {
              "description": "ID of the collection where the item was updated"
            }
          },
          {
            "name": "siteId",
            "type": "String",
            "selector": [
              "siteId"
            ],
            "meta": {
              "description": "ID of the site where the item was updated"
            }
          }
        ]
      }
    ]
  },
  {
    "handle": "custom_domains",
    "meta": {
      "short": "Custom Domains",
      "description": "Manage custom domains for a site."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/custom_domains",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "name",
        "type": "String",
        "selector": [
          "name"
        ],
        "meta": {
          "description": "Domain name"
        }
      },
      {
        "name": "url",
        "type": "String",
        "selector": [
          "url"
        ],
        "meta": {
          "description": "Domain URL"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    }
  },
  {
    "handle": "users",
    "meta": {
      "short": "Users",
      "description": "Manage users for a site."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/users",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Unique identifier for the user"
        }
      },
      {
        "name": "email",
        "type": "String",
        "selector": [
          "data",
          "email"
        ],
        "meta": {
          "description": "Email address of the user"
        }
      },
      {
        "name": "status",
        "type": "String",
        "selector": [
          "data",
          "status"
        ],
        "meta": {
          "description": "Status of the user"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "User ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "update": {
        "method": "PATCH",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "User ID",
              "required": true
            }
          ]
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"data\": {\"email\": \"{{email}}\"}}",
          "placeholders": [
            {
              "name": "email",
              "type": "String",
              "description": "User email",
              "required": false
            }
          ]
        }
      },
      "delete": {
        "method": "DELETE",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "User ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    }
  },
  {
    "handle": "access_groups",
    "meta": {
      "short": "Access Groups",
      "description": "Manage access groups for a site."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/accessgroups",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Unique identifier for the access group"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    }
  },
  {
    "handle": "products",
    "meta": {
      "short": "Products",
      "description": "Manage ecommerce products."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/products",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Product ID"
        }
      },
      {
        "name": "name",
        "type": "String",
        "selector": [
          "fieldData",
          "name"
        ],
        "meta": {
          "description": "Product name"
        }
      },
      {
        "name": "slug",
        "type": "String",
        "selector": [
          "fieldData",
          "slug"
        ],
        "meta": {
          "description": "Product slug"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Product ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "create": {
        "method": "POST",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"fieldData\": {\"name\": \"{{name}}\", \"slug\": \"{{slug}}\"}}",
          "placeholders": [
            {
              "name": "name",
              "type": "String",
              "description": "Product name",
              "required": true
            },
            {
              "name": "slug",
              "type": "String",
              "description": "Product slug",
              "required": true
            }
          ]
        }
      },
      "update": {
        "method": "PATCH",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Product ID",
              "required": true
            }
          ]
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"fieldData\": {\"name\": \"{{name}}\", \"slug\": \"{{slug}}\"}}",
          "placeholders": [
            {
              "name": "name",
              "type": "String",
              "description": "Product name",
              "required": false
            },
            {
              "name": "slug",
              "type": "String",
              "description": "Product slug",
              "required": false
            }
          ]
        }
      }
    }
  },
  {
    "handle": "orders",
    "meta": {
      "short": "Orders",
      "description": "Manage ecommerce orders."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/orders",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "orderId"
        ],
        "meta": {
          "description": "Order ID"
        }
      },
      {
        "name": "status",
        "type": "String",
        "selector": [
          "status"
        ],
        "meta": {
          "description": "Order fulfilling status"
        }
      },
      {
        "name": "total",
        "type": "String",
        "selector": [
          "totals",
          "total",
          "value"
        ],
        "meta": {
          "description": "Order total amount"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Order ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "update": {
        "method": "PATCH",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Order ID",
              "required": true
            }
          ]
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"fields\": {\"status\": \"{{status}}\"}}",
          "placeholders": [
            {
              "name": "status",
              "type": "String",
              "description": "Order status (unfulfilled, fulfilled, etc.)",
              "required": true
            }
          ]
        }
      }
    }
  },
  {
    "handle": "inventory",
    "meta": {
      "short": "Inventory",
      "description": "Manage ecommerce inventory."
    },
    "endpoint": {
      "value": "/collections/{{collectionId}}/items/{{itemId}}/inventory",
      "placeholders": [
        {
          "name": "collectionId",
          "type": "String",
          "description": "Collection ID",
          "required": true
        },
        {
          "name": "itemId",
          "type": "String",
          "description": "Item ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "inventoryType"
        ],
        "meta": {
          "description": "Inventory type"
        }
      },
      {
        "name": "quantity",
        "type": "String",
        "selector": [
          "quantity"
        ],
        "meta": {
          "description": "Inventory quantity"
        }
      }
    ],
    "operations": {
      "read": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "update": {
        "method": "PATCH",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"fields\": {\"quantity\": \"{{quantity}}\"}}",
          "placeholders": [
            {
              "name": "quantity",
              "type": "String",
              "description": "Inventory quantity",
              "required": true
            }
          ]
        }
      }
    }
  },
  {
    "handle": "forms",
    "meta": {
      "short": "Forms",
      "description": "Manage site forms."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/forms",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Unique identifier for the form"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    }
  },
  {
    "handle": "form_submissions",
    "meta": {
      "short": "Form Submissions",
      "description": "Manage site form submissions."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/forms/{{formId}}/submissions",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        },
        {
          "name": "formId",
          "type": "String",
          "description": "Form ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Unique identifier for the form submission"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    }
  },
  {
    "handle": "pages",
    "meta": {
      "short": "Pages",
      "description": "Manage site pages."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/pages",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Unique identifier for the page"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    }
  },
  {
    "handle": "assets",
    "meta": {
      "short": "Assets",
      "description": "Manage site assets."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/assets",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Asset ID"
        }
      },
      {
        "name": "contentType",
        "type": "String",
        "selector": [
          "contentType"
        ],
        "meta": {
          "description": "Asset content type"
        }
      },
      {
        "name": "originalFileName",
        "type": "String",
        "selector": [
          "originalFileName"
        ],
        "meta": {
          "description": "Original file name"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Asset ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "create": {
        "method": "POST",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": null
      },
      "delete": {
        "method": "DELETE",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Asset ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    }
  },
  {
    "handle": "asset_folders",
    "meta": {
      "short": "Asset Folders",
      "description": "Manage site asset folders."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/asset_folders",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Folder ID"
        }
      },
      {
        "name": "displayName",
        "type": "String",
        "selector": [
          "displayName"
        ],
        "meta": {
          "description": "Display name of the folder"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Folder ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "create": {
        "method": "POST",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"displayName\": \"{{displayName}}\"}",
          "placeholders": [
            {
              "name": "displayName",
              "type": "String",
              "description": "Display name of the new folder",
              "required": true
            }
          ]
        }
      }
    }
  },
  {
    "handle": "registered_scripts",
    "meta": {
      "short": "Registered Scripts",
      "description": "Manage site registered scripts."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/registered_scripts",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Unique identifier for the registered script"
        }
      },
      {
        "name": "version",
        "type": "String",
        "selector": [
          "version"
        ],
        "meta": {
          "description": "Script version"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "create": {
        "method": "POST",
        "path": {
          "value": "/inline",
          "placeholders": []
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": null
      }
    }
  },
  {
    "handle": "webhooks",
    "meta": {
      "short": "Webhooks",
      "description": "Manage site webhooks."
    },
    "endpoint": {
      "value": "/sites/{{siteId}}/webhooks",
      "placeholders": [
        {
          "name": "siteId",
          "type": "String",
          "description": "Site ID",
          "required": true
        }
      ]
    },
    "fields": [
      {
        "name": "id",
        "type": "String",
        "selector": [
          "id"
        ],
        "meta": {
          "description": "Webhook ID"
        }
      },
      {
        "name": "triggerType",
        "type": "String",
        "selector": [
          "triggerType"
        ],
        "meta": {
          "description": "Trigger type"
        }
      },
      {
        "name": "url",
        "type": "String",
        "selector": [
          "url"
        ],
        "meta": {
          "description": "Webhook URL"
        }
      }
    ],
    "operations": {
      "list": {
        "method": "GET",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "read": {
        "method": "GET",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Webhook ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      },
      "create": {
        "method": "POST",
        "path": {
          "value": "",
          "placeholders": []
        },
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {},
        "bodyTemplate": {
          "value": "{\"triggerType\": \"{{triggerType}}\", \"url\": \"{{url}}\"}",
          "placeholders": [
            {
              "name": "triggerType",
              "type": "String",
              "description": "Event trigger type",
              "required": true
            },
            {
              "name": "url",
              "type": "String",
              "description": "Webhook URL",
              "required": true
            }
          ]
        }
      },
      "delete": {
        "method": "DELETE",
        "path": {
          "value": "/{{id}}",
          "placeholders": [
            {
              "name": "id",
              "type": "String",
              "description": "Webhook ID",
              "required": true
            }
          ]
        },
        "headers": {},
        "queryParams": {},
        "bodyTemplate": null
      }
    }
  }
]
```

<p align="center"><a class="button primary" data-icon="square-caret-right">Try @Human</a><a class="button primary" data-icon="check">Buy @Human Subscription</a><a class="button primary" data-icon="comments">Join @Human Community</a></p>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.planetcrust.com/human-connections/webflow/webflow.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
