Pre-Response Events

Pimcore Copilot is a Pimcore Studio plugin backed by Studio Backend API endpoints. Before one of those endpoints returns its response, the bundle dispatches a pre-response event carrying the response DTO. Subscribe to the event to read from or add data to that DTO before it is sent to the client.

All events are declared under Pimcore\Bundle\CopilotBundle\Event\PreResponse and extend Pimcore\Bundle\StudioBackendBundle\Event\AbstractPreResponseEvent. Each event class exposes a getter for the DTO it carries (for example getAction()), and AbstractPreResponseEvent itself provides addAdditionalAttribute(), getAdditionalAttribute(), hasAdditionalAttribute() and removeAdditionalAttribute() to attach arbitrary key-value data to the response. See the Studio Backend Additional and Custom Attributes documentation for the general listener pattern and a worked subscriber example.

warning

The Studio Backend API endpoints themselves are not a supported public API. Their controllers are marked @internal and may change in any release without a deprecation path. Do not build integrations against the endpoints directly; use these events instead.

Actions

Event class	Event name	Dispatched when	DTO
ActionsEvent	pre_response.copilot.actions	Once per action, before the list of available Copilot actions is returned.	Action

Automation action configuration

Event class	Event name	Dispatched when	DTO
AutomationActionCreatedEvent	pre_response.copilot.automation_action_created	A new automation action configuration was created.	AutomationActionCreated
AutomationActionConfigurationEvent	pre_response.copilot.automation_action_configuration	A single automation action configuration is read.	AutomationActionConfiguration
AutomationActionEnvironmentTypeEvent	pre_response.copilot.automation_action_environment_type	Once per registered environment variable type, before the type list is returned.	AutomationActionEnvironmentType
AutomationActionEnvironmentInlineHelpEvent	pre_response.copilot.automation_action_environment_inline_help	The inline help content for environment variable types is returned.	AutomationActionEnvironmentInlineHelp
AutomationActionPostInteractionEvent	pre_response.copilot.automation_action_post_interaction	The list of available post-interaction types is returned.	AutomationActionPostInteraction
AutomationActionPreconditionFilterEvent	pre_response.copilot.automation_action_precondition_filter	Once per registered precondition filter, before the filter list is returned.	AutomationActionPreconditionFilter
AutomationActionStepImplementationEvent	pre_response.copilot.automation_action_step_implementation	The list of available step implementations is returned.	AutomationActionStepImplementation
AutomationActionStepImplementationInlineHelpEvent	pre_response.copilot.automation_action_step_implementation_inline_help	The inline help content for step implementations is returned.	AutomationActionStepImplementationInlineHelp

Interaction action configuration

Event class	Event name	Dispatched when	DTO
InteractionActionCreatedEvent	pre_response.copilot.interaction_action_created	A new interaction action configuration was created.	InteractionActionCreated
InteractionActionConfigurationEvent	pre_response.copilot.interaction_action_configuration	A single interaction action configuration is read.	InteractionActionConfiguration
InteractionActionTypeEvent	pre_response.copilot.interaction_action_type	Once per registered interaction type, before the type list is returned.	InteractionActionType
InteractionActionInlineHelpEvent	pre_response.copilot.interaction_action_inline_help	The inline help content for interaction types is returned.	InteractionActionInlineHelp

Interaction action runtime

Dispatched while a chat or one-step interaction is executed. See Extending Interaction Actions for background on interaction types.

Event class	Event name	Dispatched when	DTO
InteractionActionChatHistoryEvent	pre_response.copilot.interaction_action_chat_history	Once per chat history entry, when the initial or follow-up step of a chat interaction returns its history.	InteractionActionChatHistory
InteractionActionOneStepEvent	pre_response.copilot.interaction_action_one_step	A one-step interaction has produced its result.	InteractionActionOneStep

Job runs

Event class	Event name	Dispatched when	DTO
CopilotJobRunIdEvent	pre_response.copilot.job_run_id	An automation action was launched and its job run ID is returned.	CopilotJobRunId
JobRunEvent	pre_response.copilot.job_runs	Once per job run, when a job run list is returned or a job run is rerun.	CopilotJobRun
JobRunProgressEvent	pre_response.copilot.job_runs.progress	The progress of a job run is returned.	CopilotJobRunProgress

Configuration and context

Event class	Event name	Dispatched when	DTO
ConfigurationTreeNodeEvent	pre_response.copilot.configuration_tree_node	Once per node, when the configuration tree (automation and interaction actions) is returned.	ConfigurationTreeNode
ConfigurationImportEvent	pre_response.copilot.configuration_import	A configuration was imported.	ConfigurationImport
ConfigurationEventDefinitionEvent	pre_response.copilot.configuration_event	Once per available workflow or core event, when the list of events usable as automation action triggers is returned.	ConfigurationEventDefinition
ContextLimitationEvent	pre_response.copilot.context_limitation	Once per entry, when the list of available context limitations is returned.	ContextLimitation

Data objects and workflows

Event class	Event name	Dispatched when	DTO
DataObjectClassDefinitionEvent	pre_response.copilot.data_object_class_definition	Once per data object class, when the list of class definitions is returned.	DataObjectClassDefinition
WorkflowEvent	pre_response.copilot.workflow	Once per workflow, when the list of workflows is returned.	CopilotWorkflow

Permissions

Event class	Event name	Dispatched when	DTO
PermissionGridEntryEvent	pre_response.copilot.permission_grid_entry	Once per user or role entry, when the permission grid is returned.	PermissionGridEntry