Manifest

The App Manifest contains all metadata for your app. It specifies Flow Cards, Drivers, etc.
/.homeycompose/app.json
1
{
2
  "id": "my.company.example",
3
  "version": "1.0.0",
4
  "compatibility": ">=5.0.0",
5
  "platforms": ["local", "cloud"],
6
  "sdk": 3,
7
  "brandColor": "#FF0000",
8
  "name": { "en": "My App" },
9
  "description": { "en": "Adds support for Example devices." },
10
  "category": "lights",
11
  "tags": { "en": ["example"] },
12
  "images": {
13
    "small": "/assets/images/small.png",
14
    "large": "/assets/images/large.png",
15
    "xlarge": "/assets/images/xlarge.png"
16
  },
17
  "permissions": ["homey:manager:api"],
18
  "author": {
19
    "email": "[email protected]",
20
    "name": "John Doe"
21
  }
22
}
Copied!
Properties
Name
Description
id
The ID of your app. This is a reversed domain-name.
version
A Semantic Version of your app. Note that pre-release versions (e.g. 1.0.0-rc.1) are not allowed.
compatibility
A Semantic Version indicating a range of Homey versions your app is compatible with. Use at least "compatibility": ">=5.0.0" (larger or equal than v5.0.0).
platforms
An array containing the app's supported platforms. Read the Homey Cloud guide for more information.
sdk
The SDK level of your app. Should be 3.
brandColor
A HEX string for the app's brand color. The brand color is not allowed to be very bright.
name
A translation object with the name of your app.
description
A translation object with the description (oneliner) of your app.
category
A string with the Homey App Store category. Allowed categories are: lights, video, music, appliances, security, climate, tools, internet, localization, energy.
tags
A translation object with searchable tags for the App Store.
images
An object containing two paths, small and large, and optionally a third: xlarge.
permissions
An array of Permissions.
author
An object indicating the author of the app. The field author.name is required, author.email is optional.
Additional properties
The following app manifest properties are optional but can be used to document extra information about your app. Most of this information will be presented to users in the Homey App Store.
Contributors
An object with developers, following the same format as author.
/.homeycompose/app.json
1
{
2
  "id": "com.athom.example",
3
  // ...
4
  "contributors": {
5
    "developers": [
6
      {
7
        "name": "Alice the Wild",
8
        "email": "[email protected]"
9
      }
10
    ],
11
    "translators": [
12
      {
13
        "name": "Klemens Kohlmann"
14
      }
15
    ]
16
  }
17
}
Copied!
Contributing
Perhaps some users want to show their appreciation for your hard work in the form of a small donation.
When adding one or more donation options to your app's manifest, a Donate button will appear on your app's page.
Donate buttons are only visible for non-verified developers.
/.homeycompose/app.json
1
{
2
  "id": "com.athom.example",
3
  // ...
4
  "contributing": {
5
    "donate": {
6
      "paypal": {
7
        // Will link to https://paypal.me/my_paypal_username
8
        "username": "my_paypal_username"
9
      },
10
      "bunq": {
11
        // Will link to https://bunq.me/my_bunq_username
12
        "username": "my_bunq_username"
13
       },
14
       "patreon": {
15
         // Will link to https://www.patreon.com/my_patreon_username
16
         "username": "my_patreon_username"
17
       },
18
       "githubSponsors": {
19
         // Will link to https://github.com/sponsors/my_github_username
20
         "username": "my_github_username"
21
       }
22
    }
23
  }
24
}
Copied!
Bugs
Users can come across an issue in your app. Provide them with a bug URL, so they can quickly share their findings with you. An object with a property url that contains a link to your public bug/issue tracker.
/.homeycompose/app.json
1
{
2
  "id": "com.athom.example",
3
  // ...
4
  "bugs": {
5
    "url": "https://bitbucket.org/athom/com.athom.myapp/issues"
6
  }
7
}
Copied!
Homey Community Topic
The Homey Community is a great place to share additional information about your app with your users and fellow developers. When the ID of the topic is provided, this shows a link on the App Store. You can get the ID from the topic's URL.
/.homeycompose/app.json
1
{
2
  "id": "com.athom.example",
3
  // ...
4
  "homeyCommunityTopicId": 1234
5
}
Copied!
Source
If you would like to, you can add a link to your source code to allow others to view your code and maybe even submit a Pull Request. A string, starting with https://.
/.homeycompose/app.json
1
{
2
  "id": "com.athom.example",
3
  // ...
4
  "source": "https://github.com/athombv/com.athom.myapp"
5
}
Copied!
Homepage
Share your company, brand or personal page with users to give them some more insight. A string, starting with https://.
/.homeycompose/app.json
1
{
2
  "id": "com.athom.example",
3
  // ...
4
  "homepage": "https://homey.app"
5
}
Copied!
Support
Sometimes your users need some help or might have some questions about your app. Consider offering them support, just in case they need it. Add a URL or e-mail address to the app manifest. A support URL is mandatory for Verified Developers. A string, starting with https:// or mailto:.
/.homeycompose/app.json
1
{
2
  "id": "com.athom.example",
3
  // ...
4
  "support": "mailto:[email protected]"
5
}
Copied!

The Basics - Previous

App

Internationalization

Last modified 2mo ago

Copy link

Contents

Properties

Additional properties

Contributors

Contributing

Bugs

Homey Community Topic

Source

Homepage

Support