{"templateId":"markdown","versions":[{"version":"v1.43","label":"v1.43 LTS","link":"/products/custody/deployment/reference/notifications","default":true,"active":false,"folderId":"c15a2701"},{"version":"v1.42","label":"v1.42 STS","link":"/products/custody/v1.42/deployment/reference/notifications","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.41","label":"v1.41 STS","link":"/products/custody/v1.41/deployment/reference/notifications","default":false,"active":true,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/deployment/reference/notifications","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/deployment/reference/notifications","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/deployment/reference/notifications","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/deployment/reference/notifications","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Notifications configuration","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"notifications-configuration","__idx":0},"children":["Notifications configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this page to understand notification service and email notification fields for ","Ripple Custody",". The example shows one possible configuration shape; SMTP provider, credentials, resource values, scaling, and delivery policy depend on your deployment."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page applies to on-premise deployments only. For current defaults and the full supported schema, use the configuration packaged with your release."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-this-config-controls","__idx":1},"children":["What this config controls"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The notification system handles notification processing, persistence, real-time delivery, and optional email delivery. Email notification settings are configured under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.notifications.email"]},". The notification service component is configured under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["components.notification"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"email-fields","__idx":2},"children":["Email fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Location: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.notifications.email"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Enables email notifications."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sender"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize@example.com"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sender address for email notifications."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smtp.host"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smtp.example.com"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMTP server hostname."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smtp.port"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"25\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMTP server port. Common values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["25"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["465"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["587"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2525"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smtp.username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMTP authentication username."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smtp.password"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMTP authentication password. Store through your secret-management process."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SMTP port notes:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Port"},"children":["Port"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Protocol"},"children":["Protocol"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["25"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMTP"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["465"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMTPS"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["587"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMTP with STARTTLS"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2525"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMTP with STARTTLS"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"notification-component-fields","__idx":3},"children":["Notification component fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Location: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["components.notification"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Enables the notification component."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["image.repository"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notification service image repository."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["image.tag"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notification service image tag."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["replicas"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of notification service replicas."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resources.requests"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CPU and memory requests."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resources.limits"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CPU and memory limits."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["service.main.ports.http.port"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service HTTP port."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["service.main.ports.http.targetPort"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container target port."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["autoscaling"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Horizontal autoscaling settings, where exposed by your release."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Resource and replica values are workload-dependent. Set them based on expected notification volume and observed runtime behavior."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"environment-variables","__idx":4},"children":["Environment variables"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Variable"},"children":["Variable"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example or source"},"children":["Example or source"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LOG_LEVEL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notification service log level."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["info"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["debug"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warn"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POSTGRES_URL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PostgreSQL connection string."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Secret"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["OAuth credentials, database schema, and inter-service URLs are managed by the deployment configuration unless explicitly exposed."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"notification-templates","__idx":5},"children":["Notification templates"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The notification service uses built-in templates for notification categories such as transaction updates, approval requests, security alerts, system notifications, and custom application notifications."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"constraints-and-relationships","__idx":6},"children":["Constraints and relationships"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Email notifications require SMTP connection details."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["SMTP credentials should be supplied through your secret-management process."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Notification persistence requires PostgreSQL connectivity."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Event-driven notification processing depends on AMQP configuration."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Notification APIs depend on OAuth authentication configuration."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example","__idx":7},"children":["Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This example shows email notification settings and the notification component in one deployment values file:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"harmonize:\n  notifications:\n    email:\n      enabled: true\n      sender: \"noreply@example.com\"\n      smtp:\n        host: \"smtp.example.com\"\n        port: \"587\"\n        username: \"<smtp-user>\"\n        password: \"<smtp-password>\"\n\ncomponents:\n  notification:\n    enabled: true\n    replicas: 1\n    resources:\n      limits:\n        cpu: 1000m\n        memory: 1024Mi\n      requests:\n        cpu: 100m\n        memory: 256Mi\n    service:\n      main:\n        ports:\n          http:\n            port: 80\n            targetPort: 3000\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-topics","__idx":8},"children":["Related topics"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.41/deployment/reference/oauth-server"},"children":["OAuth server configuration"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.41/deployment/reference/amqp"},"children":["AMQP configuration"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.41/deployment/reference/networking"},"children":["Networking configuration"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.41/deployment/reference/postgresql"},"children":["PostgreSQL configuration"]}]}]}]},"headings":[{"value":"Notifications configuration","id":"notifications-configuration","depth":1},{"value":"What this config controls","id":"what-this-config-controls","depth":2},{"value":"Email fields","id":"email-fields","depth":2},{"value":"Notification component fields","id":"notification-component-fields","depth":2},{"value":"Environment variables","id":"environment-variables","depth":2},{"value":"Notification templates","id":"notification-templates","depth":2},{"value":"Constraints and relationships","id":"constraints-and-relationships","depth":2},{"value":"Example","id":"example","depth":2},{"value":"Related topics","id":"related-topics","depth":2}],"frontmatter":{"seo":{"title":"Notifications configuration"}},"lastModified":"2026-10-23T14:40:23.899Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/v1.41/deployment/reference/notifications","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}