[
{
"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
}
}
}
]