{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"JSON File","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":"json-file","__idx":0},"children":["JSON File"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When developing modules for WHMCS, you can place a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whmcs.json"]}," file in the module's root directory to provide additional meta information that WHMCS will use in display of the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Apps & Integrations"]}," pages."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A sample ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whmcs.json"]}," is provided below:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"schema\": \"1.0\",\n  \"type\": \"whmcs-notifications\",\n  \"name\": \"email\",\n  \"license\": \"proprietary\",\n  \"category\": \"notifications\",\n  \"description\": {\n    \"name\": \"Email\",\n    \"tagline\": \"Configure rule based notifications delivered by email.\",\n    \"long\": \"Setup advanced rule based notifications for events and triggers that matter to you and receive those notifications to one or more email addresses.\",\n    \"features\": [\n      \"Setup rule based events and triggers\",\n      \"Receive notifications by email\"\n    ]\n  },\n  \"logo\": {\n    \"filename\": \"logo.png\"\n  },\n  \"support\": {\n    \"homepage\": \"https:\\/\\/www.whmcs.com\\/\", \n    \"learn_more\": \"https:\\/\\/www.whmcs.com\\/tour\", \n    \"email\": \"support@whmcs.com\", \n    \"support_url\": \"https:\\/\\/support.whmcs.com\\/\",\n    \"docs_url\": \"https:\\/\\/docs.whmcs.com\\/Notifications\"\n  },\n  \"authors\": [\n    {\n      \"name\": \"WHMCS\",\n      \"homepage\": \"https:\\/\\/www.whmcs.com\\/\"\n    }\n  ]\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A brief description of each parameter and what it is used for can be found below:"]},{"$$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":"Usage"},"children":["Usage"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The current version of the whmcs.json file structure."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of module. The available types are: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whmcs-addons"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whmcs-fraud"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whmcs-gateways"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whmcs-registrars"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whmcs-security"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whmcs-servers"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whmcs-notifications"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of the module."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["license"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Which type of license the module is released under."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["category"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The category in which the module should be organized."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["description"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional parameters that describe the module."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["description.name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The display name of the module."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["description.tagline"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A short summary description of the module."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["description.long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A more detailed description of the module."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["description.features"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An array containing each feature that will display as a list of bullet points."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["logo.filename"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The file that should be used as the module logo (500 pixel recommended width."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["support.homepage"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A URL that links to the website homepage for the module."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["support.learn_more"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A URL that links to a page with additional information about the module."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["support.email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The email address to contact to get support for the module"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["support.support_url"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A URL that links to a support desk or resources for the module."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["support.docs_url"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A URL that links to the documentation for the module."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["authors"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An array of objects that represent each author and a link to their website."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["author name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of the module author."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["author homepage"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A URL that links to the module author's website."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The logo.png file used for a module should not exceed ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["500"]}," pixels in width. An example placeholder logo for reference can be found below:"]},{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/module-image-placeholder.528678deecebda503aae4e23c247a59affaa6988fb98edf4ec438f283d06ada2.29962483.png","alt":"Module Image Placeholder"},"children":[]}]},"headings":[{"value":"JSON File","id":"json-file","depth":1}],"frontmatter":{"title":"JSON File","seo":{"title":"JSON File"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/advanced/json-file","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}