{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Notification Settings","description":"Developer documentation for the WHMCS API — the","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"notification-settings","__idx":0},"children":["Notification Settings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Notification Settings are configured on a per notification rule basis."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Notification Settings should be used for user configurable settings that are specific to an individual notification. For settings that are the same for all notification rules, ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/notification-providers/provider-settings"},"children":["Provider Settings"]}," should be used instead."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the case of our HipChat and Slack notification providers, examples of Notification Settings are fields for defining the Channel/Room to notify, as well as the ability to customise the notification message body."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The field definitions you return from this method are used to build a form in the admin notification rule user interface."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported field types are: text, password, yesno, dropdown, radio, textarea and dynamic."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"public function notificationSettings()\n{\n    return [\n        'priority' => [\n            'FriendlyName' => 'Notification Priority',\n            'Type' => 'dropdown',\n            'Options' => [\n                'Low',\n                'Medium',\n                'High',\n            ],\n            'Description' => 'Choose the notification priority for the alert.',\n        ],\n    ];\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See also ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/notification-providers/dynamic-fields"},"children":["Dynamic Fields"]}]}]},"headings":[{"value":"Notification Settings","id":"notification-settings","depth":1}],"frontmatter":{"title":"Notification Settings","seo":{"title":"Notification Settings"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/notification-providers/notification-settings","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}