Create collection field - Automate.ax

webflow.createCollectionField adds a typed field to an existing CMS collection.

Example

automations/webflow-create-collection-field.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { webflow } from "automate.ax/webflow"

export default automation("Create collection field", () => {
  onDashboardRun({ title: "Create collection field" })

  webflow.createCollectionField({
    collectionId: "collection-id",
    displayName: "Related article",
    isRequired: false,
    metadata: { collectionId: "related-collection-id" },
    type: "Reference",
  })
})

Inputs

Every input accepts a compatible signal. It requires the cms:write OAuth scope.

Field	Type	Required	Description
`id`	`string`	No	Webflow `id` value.
`isEditable`	`boolean`	No	Webflow `isEditable` value.
`isRequired`	`boolean`	No	Webflow `isRequired` value.
`type`	`Webflow.StaticFieldType \| "Option" \| Webflow.ReferenceFieldType`	Yes	Webflow `type` value.
`displayName`	`string`	Yes	Webflow `displayName` value.
`helpText`	`string`	No	Webflow `helpText` value.
`collectionId`	`string`	Yes	Webflow CMS collection ID.

Output

Returns an object with the fields below. Automate.ax converts provider Date values to ISO 8601 strings.

Field	Type	Description
`id`	`string`	Webflow `id` value.
`isEditable`	`boolean`	Webflow `isEditable` value.
`isRequired`	`boolean`	Webflow `isRequired` value.
`type`	`Webflow.StaticFieldType \| "Option" \| Webflow.ReferenceFieldType`	Webflow `type` value.
`displayName`	`string`	Webflow `displayName` value.
`helpText`	`string`	Webflow `helpText` value.