Plugin settings can be accessed via OctoPrint settings, by clicking on "Telegram" in the sidebar. Please note that only admin users are allowed to modify certain sensitive settings.

The plugin settings are organized into tabs. Each of the following sections in this wiki corresponds to one of those tabs.

Connection

This tab allows you to set or change the Telegram bot token used by the plugin. Instructions on how to obtain a bot token can be found in the Installation section of this wiki.

Paste your token into the Telegram bot token field (see point 3 in the screenshot above) and test it using the Test above token button (point 4 in the screenshot above).

The configuration will only be applied once you click the Save button.

General settings

This tab allows you to configure the general settings of the plugin.

The following points are numbered according to the labels in the screenshots:

2. Send notification every: a status message will be sent whenever either the current Z value increases by the specified amount, or the given time has passed since the last notification.

   • Setting the height to 1.0mm sends messages at z = 1.0, 2.0, 3.0 and so on.
   • Setting the height to 1.0mm with a layer height of 0.3 would send messages at z = 1.2, 2.4, 3.6 and so on.
   • Setting the height or time to 0 disables that individual check. Setting both to 0 completely disables Z-change notifications during printing.

3. Delay for finished print notification: sets a delay before sending the end-of-print message, allowing the print head to move out of the camera view.

4. Enable emojis: when disabled, messages sent by the bot will not include emojis.

5. Message on a loop: when enabled, the plugin will continuously poll the printer to retrieve print status, even for jobs started from the SD card. Enable this if you primarily print from SD, but be aware that functionality may be limited and some features might not work correctly.

6. Gifs generation prerequisites: these status badges indicate whether the required software for GIF creation is installed. If they appear red, the dependencies are missing. Follow the instructions in the Additional Requirements section to install them.

7. Enable GIFs: check this box to enable GIF generation. GIFs are only generated for notification events where they are explicitly enabled in the Notification messages tab — this setting acts as a global switch. Enable it only if your OctoPrint server is sufficiently powerful (e.g., a Raspberry Pi 4B+ is suitable), as GIF generation may impact performance on lower-end systems.

8. Pre / Post image actions: here you can define actions (G-code or system commands) to be executed before and after capturing webcam snapshots. This is useful, for example, to run a script that turns on LEDs before taking a picture.

Chats

This tab allows you to configure per-chat settings.

Send a message to the bot in a private chat, or add it to a group. Then, click the Refresh button (label 1 in the screenshot above). A new row corresponding to the chat should appear in the "Known chats" table.

Next, click the pencil icon (label 2 in the screenshot above) in the chat’s row to configure whether that chat is allowed to receive notifications and use commands.

---

If you're editing a user chat, the following dialog will appear:

• The two Allow to send commands and Send notifications checkboxes allow you to enable command usage and notifications for the user.
  To define which specific commands the user can send and which notifications they will receive, use the buttons labeled 3 and 4 in the user’s row in the table above.

---

If you're editing a group chat, the following dialog will appear:

• The Allow individual user command permissions checkbox lets users in the group use commands they are individually allowed to execute.

  Example:
  Users A and B are in the same group.
  User A has /print enabled, user B does not. Both have /status enabled.
  → User A can send /print and /status, while user B can only send /status.
  

• The Allow all group members to send enabled commands checkbox allows any group member to use commands that are enabled globally for the group.
  These global commands can be configured by clicking the button labeled 4 in the group’s row.

• The Allow all group members to send enabled commands checkbox allows any user in the group to use the commands that are globally enabled for the group. These commands can be configured by clicking the button labeled 4 on the group’s row in the table. If Allow individual user command permissions is also enabled, users will be able to use both the commands enabled for the group and those individually enabled for them.

  Example:
  "Allow individual user command permissions" is enabled for the group. Users A and B are in the group.
  User A has /print enabled individually, but the group does not. The group has /status enabled, but user A does not.
  User B has no individually allowed commands.
  
  → User A can send /print (individual rights) and /status (group rights).
  → User B can only send /status (group rights).
  
  If "Allow individual user command permissions" is disabled, both users will be restricted to /status only (group rights).
  

• The Send notifications checkbox enables the reception of notifications in the group chat.
  The specific types of notifications to send can be configured by clicking the button labeled 3 in the group’s row.

---

By clicking the buttons labeled 3 and 4 in the screenshot above, you can configure which specific notifications and commands are enabled for the selected chat:

Notification messages

This tab allows you to configure the content and format of each notification message — including the text, formatting, and whether to attach webcam snapshots or videos.

These messages are shared across all chats and are sent to any chat where the corresponding notification type is enabled (see the Chats section).

Each notification message includes a description of the condition that triggers it.

You can customize the message text using dynamic variables and emojis. The available options are shown in the pop-up dialogs opened by clicking the Variables and Emojis buttons.

For each message, you can configure the following options using toggle switches:

• Send camera photos and Send camera gifs: whether to attach snapshots and videos from all configured webcams.
• Send silently: whether to send the message in silent mode (without triggering a notification sound).