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

dokploy_resend_notification (Resource)

A Resend notification channel (Settings > Notifications). Dokploy sends each message as an email through the Resend API.

Each event attribute selects one Dokploy event that sends a message on this channel. All events default to false, so a new channel sends nothing until you enable one.

~> Dokploy does not test the channel on create or update. A wrong URL or token applies successfully and fails on the first message. Set verify_connection = true to test the channel before the write.

~> Dokploy stores and returns api_key in cleartext. The attribute is sensitive, so Terraform does not print it, but anyone with API access to the server can read it. The api_key_wo companion keeps it out of the Terraform state.

Example Usage

terraform
# Email through Resend, from a domain that Resend verified.
resource "dokploy_resend_notification" "ops" {
  name         = "ops-resend"
  from_address = "[email protected]"
  to_addresses = ["[email protected]"]

  api_key_wo         = var.resend_api_key
  api_key_wo_version = 1

  app_build_error = true
  database_backup = true
}

Schema

Required

  • from_address (String) Sender address on a domain that Resend verified.
  • name (String) Display name. Dokploy does not enforce a unique name.
  • to_addresses (List of String) Recipient addresses. At least one.

Optional

NOTE: Write-only arguments are supported in Terraform 1.11 and later.

  • api_key (String, Sensitive) Resend API key. Set this attribute or api_key_wo.
  • api_key_wo (String, Sensitive, Write-only) Write-only form of api_key. Terraform keeps it out of the plan and the state. It needs Terraform 1.11 or later. Set exactly one of api_key and api_key_wo. A new value reaches the server only when api_key_wo_version changes.
  • api_key_wo_version (Number) Version of api_key_wo. Change it to send the current api_key_wo value to the server. It needs api_key_wo.
  • app_build_error (Boolean) Send a message when a build fails. Defaults to false.
  • app_deploy (Boolean) Send a message when an application or a compose deploys. Defaults to false.
  • database_backup (Boolean) Send a message when a database backup runs. Defaults to false.
  • docker_cleanup (Boolean) Send a message when the Docker cleanup runs. Defaults to false.
  • dokploy_backup (Boolean) Send a message when the Dokploy server backup runs. Defaults to false.
  • dokploy_restart (Boolean) Send a message when Dokploy restarts. Defaults to false.
  • server_threshold (Boolean) Send a message when a server crosses a resource threshold. Defaults to false.
  • verify_connection (Boolean) Test the connection with notification.testResendConnection before the provider creates or updates the record. If the test fails, the apply fails with the server message, and the provider writes nothing. The default is no check: null and false both skip the test. Dokploy stores no value for this attribute, so terraform import leaves it null. The test sends a real test message to the channel.
  • volume_backup (Boolean) Send a message when a volume backup runs. Defaults to false.

Read-Only

  • created_at (String) Creation timestamp from the server.
  • id (String) Notification id.

Import

Import is supported using the following syntax:

In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

terraform
import {
  to = dokploy_resend_notification.ops
  id = "INt_PYqh9apo8mmDIoixZ"
}

The terraform import command can be used, for example:

shell
terraform import dokploy_resend_notification.ops INt_PYqh9apo8mmDIoixZ