hooks.rst

Available plugin hooks

Note

All of the hooks below take at least two parameters, *args and **kwargs. Please make sure those are present. They will act as placeholders if additional parameters are added to the hooks in the future and will allow your plugin to stay compatible to OctoPrint without any necessary adjustments from you in these cases.

octoprint.accesscontrol.appkey

octoprint.comm.protocol.action

octoprint.comm.protocol.gcode.<phase>

This describes actually four hooks:

• octoprint.comm.protocol.gcode.queuing
• octoprint.comm.protocol.gcode.queued
• octoprint.comm.protocol.gcode.sending
• octoprint.comm.protocol.gcode.sent

octoprint.comm.protocol.scripts

octoprint.comm.transport.serial.factory

octoprint.filemanager.extension_tree

octoprint.filemanager.preprocessor

octoprint.server.http.bodysize

octoprint.server.http.routes

octoprint.ui.web.templatetypes