Extending
Custom Layouts
Register a new layout type as a tagged service, see Adding a Custom Layout.
Studio API Events
The Headless Documents configuration panels (Headless Templates, Headless Bricks, and the Datahub configuration detail view) are Pimcore Studio plugins. Before one of their endpoints returns, the bundle dispatches a pre-response event carrying the response schema. Listen for it to add your own data to the response.
| Event | Description |
|---|---|
pre_response.headless_documents.template_list | The list of template IDs and names. |
pre_response.headless_documents.template_tree | One template node in the template tree. |
pre_response.headless_documents.template_tree_folder | One group (folder) node in the template tree. |
pre_response.headless_documents.template_detail | A single template configuration. |
pre_response.headless_documents.template_help | The inline help content for templates (layouts and editables). |
pre_response.headless_documents.brick_list | The list of brick IDs and names. |
pre_response.headless_documents.brick_tree | One brick node in the brick tree. |
pre_response.headless_documents.brick_tree_folder | One group (folder) node in the brick tree. |
pre_response.headless_documents.brick_detail | A single brick configuration. |
pre_response.headless_documents.brick_help | The inline help content for bricks (editables). |
pre_response.headless_documents.datahub_configuration_detail | A single Headless Documents Datahub configuration. |
pre_response.headless_documents.datahub_configuration_update | The result of saving a Datahub configuration. The payload carries only the new modificationDate, not the saved configuration. |
Every event extends the Studio Backend AbstractPreResponseEvent, so a listener can attach additional attributes to
the response schema. See
Extending via Events
for the subscriber pattern, and
Additional and Custom Attributes
for the attribute mechanism itself.
The endpoints themselves are not a supported public API. Every Studio controller in this bundle is marked
@internal and may change in any release without a deprecation path. Do not build integrations against them.