Planekeeper is currently in alpha development. Features and APIs may change. Feedback is welcome! Request early access to get started.

Settings reference

Reference for organization-level settings including default notification channels, template defaults, and task execution configuration.

Organization-level settings control default behaviors across Planekeeper. Access settings from the Settings page in the sidebar.

How settings work

Settings are key-value pairs scoped to your organization. Each setting has:

  • A key that identifies the setting
  • A value that configures the behavior
  • An optional organization scope – organization-specific settings override global defaults

When Planekeeper needs a setting value, it checks in this order:

  1. Organization-specific value (your setting)
  2. Global default value (set by the system administrator)
  3. Built-in default (hardcoded fallback)

Notification settings

Default notification channel

Key: default_notification_channel_id

Sets the default channel used by notification rules that do not specify a channel override. When a notification rule has no explicit channel, deliveries are sent to this channel.

DetailValue
TypeChannel ID (number)
DefaultNone
RequiredNo, but notification rules without a channel override will not deliver unless this is set
success

Set a default early

Configure a default notification channel before creating notification rules. Rules without a channel override silently skip delivery when no default is set.

Notification template defaults

Set organization-wide template defaults that apply to all notification channels unless overridden at the channel level.

New alert template

Key: notification.template.alert.new

Template used for alert.created and alert.escalated events.

{"text": "{{.Alert.Severity | upper}}: {{.Alert.ConfigName}} is {{.Alert.BehindBy}} behind ({{.Alert.DiscoveredVersion}} -> {{.Alert.LatestVersion}})"}

Acknowledged template

Key: notification.template.alert.acknowledged

Template used for alert.acknowledged and alert.unacknowledged events.

{"text": "{{if .IsAcknowledged}}Acknowledged{{else}}Unacknowledged{{end}}: {{.Alert.ConfigName}} by {{.AcknowledgedBy}}"}

Resolved template

Key: notification.template.alert.resolved

Template used for alert.resolved events.

{"text": "Resolved: {{.Alert.ConfigName}} - no longer behind"}
info

Template resolution order

Channel-specific templates take priority over organization templates. Organization templates take priority over global defaults. See Template variables for the full resolution order and available variables.


Task execution settings

Task execution timeout

Key: task_execution_timeout_seconds

Controls how long an agent has to complete a task before the execution token expires. If the agent does not report results within this window, the task is considered timed out and becomes eligible for reassignment.

DetailValue
TypeSeconds (number)
Default300 (5 minutes)
Minimum30
warning

Increase for large repositories

If your scrape jobs target large Git repositories that take a long time to clone, increase this timeout to prevent premature task expiration.


Managing settings

View current settings

Navigate to Settings in the sidebar. The page displays all settings with their current values and whether they are using a default or custom value.

Update a setting

  1. Navigate to the Settings page
  2. Find the setting you want to change
  3. Enter the new value
  4. Save the change

Changes take effect immediately for new operations. In-progress jobs and deliveries continue with the values they started with.

Reset to default

Clear the value field and save to revert a setting to its default value. The system will fall back to the global default or built-in default.