skip to content
wihan.dev
view as markdown
browse the dokploy docs

dokploy_telegram_notification (Data Source)

Looks up a Telegram notification channel that already exists in Dokploy (Settings > Notifications):

terraform
data "dokploy_telegram_notification" "ops" {
  name = "ops"
}

~> The data source does not expose the bot token (bot_token). The attribute exists on the dokploy_telegram_notification resource, but not here, by design. A consumer needs only the id.

~> Dokploy does not enforce name uniqueness. If two Telegram notification channels share a name, this data source fails instead of a guess. Look the record up by id in that case.

Example Usage

terraform
data "dokploy_telegram_notification" "example" {
  id = "your-notification-id"
}

data "dokploy_telegram_notification" "ops" {
  name = "ops"
}

Schema

Optional

  • id (String) Telegram notification channel id. Set it for a lookup by id, or leave it unset and set name.
  • name (String) Display name as shown in Dokploy. Set exactly one of id or name.

Read-Only

  • app_build_error (Boolean) Whether the channel gets a message when a build fails.
  • app_deploy (Boolean) Whether the channel gets a message when an application or a compose deploys.
  • chat_id (String) Id of the chat or group that receives the message.
  • created_at (String) Creation timestamp from the server.
  • database_backup (Boolean) Whether the channel gets a message when a database backup runs.
  • docker_cleanup (Boolean) Whether the channel gets a message when the Docker cleanup runs.
  • dokploy_backup (Boolean) Whether the channel gets a message when the Dokploy server backup runs.
  • dokploy_restart (Boolean) Whether the channel gets a message when Dokploy restarts.
  • message_thread_id (String) Topic id inside a forum group, or null.
  • server_threshold (Boolean) Whether the channel gets a message when a server crosses a resource threshold.
  • volume_backup (Boolean) Whether the channel gets a message when a volume backup runs.