Well-known files

Well-known files enable features like Apple app site association, Apple Pay, and Android link verification. You can also use them to publish a security.txt file, which provides contact details for reporting website security vulnerabilities.

Features

This feature is available on Pro and Enterprise plans. You can host up to 30 well-known files per project, stored in the /.well-known/ path. Both TXT and JSON formats are supported. Subfolders within this path are not allowed.

File naming conventions

Uploaded files must follow the naming conventions required by third-party services. For example:

• Apple app site association: the file must be named apple-app-site-association (no file extension) and accessible at example.com/.well-known/apple-app-site-association.

• Android asset links: the file must be named assetlinks.json and accessible at example.com/.well-known/assetlinks.json.

Incorrect naming—such as omitting the .json extension—can cause functionality issues.

If a file is uploaded with trailing spaces or special characters (e.g., security .txt), these are automatically removed. The corrected name, such as security.txt, will be used.

Uploading well-known files

To upload well-known files:

1. Open your project settings.

2. Locate the “Well-Known Files” section.

3. Upload your TXT or JSON files.

Once your site is published, the files will be available at the /.well-known/ path.

Following these steps makes it easy to integrate third-party services with your site.