Component Object


A component is a versioned building block of an app, such as a page, widget, or webhook. In the App Dashboard and related product surfaces, components are often called extensions.

Properties
appIdstringRead-onlyformat GUID

App ID.


createdBystringRead-only

createdByVersionstringmaxLength 64

Version of the source that created the component, when provided by Wix tooling. External developers don't need to provide this field.


createdDatestringRead-onlyformat date-time

Date and time the component was created.


dataComponentData

Component data. Its structure depends on the component type. The component's type maps to the matching ComponentData oneof variant by lower-casing the enum value.


externalIdstringminLength 1maxLength 64

Developer-provided external ID for looking up related components. The ID is scoped to the app and isn't required to be unique. Empty values are ignored when saving a component.


idstringRead-onlyformat GUID

Component ID.


namestringmaxLength 200

Component name.


revisionstringRead-onlyformat int64

Revision number of the draft component. The revision increments when the draft changes and must be specified for operations that use optimistic locking.


typestringRead-only

updatedDatestringRead-onlyformat date-time

Date and time the component was updated.


versionstringRead-onlyformat int64

Component version. The draft version is 0. Published versions are immutable.

Did this help?