Skip to content

Registry Reference

The extensions_registry.json file at the root of your repository declares every widget, script, and stylesheet you want to publish. This page documents the root object; each entry type has its own reference page linked below.

Root Object

FieldTypeRequiredDefaultDescription
widgetsarrayNo[]Widget definitions — see Widget Definition Reference
scriptsarrayNo[]Script definitions — see Script Definition Reference
stylesheetsarrayNo[]Stylesheet definitions — see Stylesheet Definition Reference

All three arrays are optional. A registry with only widgets publishes no scripts or stylesheets; a registry with only scripts publishes no widgets. An empty array is valid and publishes nothing of that type.

json
{
  "widgets": [ ... ],
  "scripts": [ ... ],
  "stylesheets": [ ... ]
}

Minimal Example

The smallest valid registry:

json
{
  "widgets": [],
  "scripts": [],
  "stylesheets": []
}

This publishes nothing but passes validation. Use it to verify your repository connection before adding entries.

File Location

  • The file must be at the root of your repository.
  • Filename must be extensions_registry.json.

Migration from `widget_registry.json`

If your repository uses the old widget_registry.json filename, it still works during the migration window. Rename it to extensions_registry.json at your earliest convenience — the old name is deprecated and will be removed in a future release.

Validation

  • The root must be a JSON object.
  • widgets, scripts, and stylesheets must be arrays if present.
  • Each entry follows its own schema — see the per-type reference pages.

For validation errors, see Error Codes.

Next Steps

Gainsight CC Developer Portal