Skip to main content
Version: 2.0.0

Settings

Open Telegram → Settings in the Craft CP (or Settings → Plugins → Telegram). These are the global defaults — per-channel bot tokens, chat IDs, and automation triggers are configured separately, per channel; see Usage.

Defaults

FieldDescription
Default ChannelThe channel used when code calls send() without specifying an explicit channel. Must be an existing, enabled channel handle.
Global PrefixText prepended to a message when the selected channel itself has no prefix configured.
Include Site NameAdds the Craft site name to outgoing messages.
Include EnvironmentAdds the current Craft environment (e.g. production, staging) to outgoing messages — useful when the same bot posts from more than one environment, so a dev alert isn't mistaken for a production one.
Include TimestampAdds a timestamp to outgoing messages, off by default.
Timestamp FormatPHP date() format string used when Include Timestamp is on. Defaults to Y-m-d H:i:s.

Delivery

FieldDescription
Default Parse ModeHTML or MarkdownV2 — how Telegram parses formatting in the message text. Used unless a send call overrides it explicitly. Defaults to HTML.
Disable Web PreviewWhen on, Telegram will not unfurl links in messages. On by default, since most automated messages aren't meant to show a link preview card.
Silent NotificationsWhen on, messages are delivered without a notification sound/vibration on recipients' devices. Off by default.
Request TimeoutHTTP timeout, in seconds, for calls to the Telegram Bot API. Defaults to 10.
Max Exception Trace LengthMaximum number of stack-trace characters included when an exception notification is sent (relevant for plugins that dispatch exception details as a Telegram event). Defaults to 1500.

Logs

FieldDescription
Log Successful DeliveriesStores a log row for every successfully delivered message, not just failures. On by default.
Log Skipped EventsStores a log row when an event is skipped (no subscribed channel, missing template, disabled channel, draft/revision element, etc.), instead of silently dropping it. On by default.
Log Entry LimitMaximum number of rows kept in the Telegram log table; older rows are trimmed once the limit is reached. Defaults to 2000.

Test

FieldDescription
Test ChannelThe channel used by the Send Test Message button on this page. Independent from Default Channel, so a test channel can be kept separate from real notification traffic.
Test MessageThe text sent by Send Test Message. Defaults to "This is a Telegram test message from Craft CMS."

The Settings page also includes an inline step-by-step guide (create a bot with @BotFather, add it to a group, find the chat ID via @userinfobot or the getUpdates API) — the same steps as README → Basic setup.

See Usage → Logs for how to read and filter delivery log entries in the CP.

Site-overridable settings

Default Channel and Test Channel can be overridden per site in a multi-site install (for example, routing default notifications to a different channel per site/brand) — all other settings are global across the whole Craft install.