{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Initialisation","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":"initialisation","__idx":0},"children":["Initialisation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Notification modules require a display name and logo to be defined for them."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It is recommended to set these values during object instantiation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.whmcs.com/classes/7.4/WHMCS/Module/Notification/DescriptionTrait.html"},"children":["DescriptionTrait"]}," is made available which provides methods to fulfill this requirement."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"use DescriptionTrait;\n\n/**\n * Constructor\n */\npublic function __construct()\n{\n    $this->setDisplayName('Your Friendly Display Name')\n        ->setLogoFileName('logo.png');\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The display name should be a human friendly version of your module name."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The logo filename should be a path relative to the base directory of the module."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information on the description trait, please refer to https://docs.whmcs.com/classes/7.4/WHMCS/Module/Notification/DescriptionTrait.html"]}]},"headings":[{"value":"Initialisation","id":"initialisation","depth":1}],"frontmatter":{"title":"Initialisation","seo":{"title":"Initialisation"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/notification-providers/initialisation","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}