Summary: This guide is for developers building custom applications for the Speakap Market. It provides an example manifest file you can use as a starting point and explains each core property, including the entries array, localization, and icon codes.
The example manifest template
The JSON structure below is the blueprint configuration file for your custom application. Copy this code block and use it as a foundation, swapping out the placeholder values with your application's actual values.
{
"name": {
"en-US": "Example_Name"
},
"icon": "REPLACE_WITH_ACTUAL_URL",
"permissions": [],
"entries": [
{
"position": "external",
"devices": "desktop",
"url": "REPLACE_WITH_ACTUAL_URL",
"urlAppendNetwork": false,
"label": { "en-US": "Example_Name", "nl-NL": "Example_Name" },
"icon": "\uf1ea"
},
{
"position": "external",
"devices": "ios",
"url": "REPLACE_WITH_ACTUAL_URL",
"urlAppendNetwork": false,
"label": { "en-US": "Example_Name", "nl-NL": "Example_Name" },
"icon": "\uf1ea"
},
{
"position": "external",
"devices": "android",
"url": "REPLACE_WITH_ACTUAL_URL",
"urlAppendNetwork": false,
"label": { "en-US": "Example_Name", "nl-NL": "Example_Name" },
"icon": "\uf1ea"
}
]
}Properties breakdown
When filling in your manifest file from top to bottom, set each property as follows:
name (global)
The primary name of the application as it appears in the public or private Speakap Market. Replace "Example_Name" with your application's name.
- Example: "en-US": "Work Schedule"
icon (global)
The thumbnail or logo image shown for your application in the Speakap Market. Replace REPLACE_WITH_ACTUAL_URL with an absolute URL hosting your image.
- Example: "icon": "https://developer.speakap.io/content/themes/developer-portal/assets/images/sa-dev-logo-dark.svg"
entries (array)
An array of objects that define where and how the application opens on each platform (desktop, ios, android).
- url: The web destination of the menu item. Replace the placeholder with your target URL.
- Example: "url": "https://www.speakap.com/"
- label: The display text shown in the user's navigation menu in Speakap. This supports multiple languages for localized networks.
- Example: { "en-US": "Speakap", "nl-NL": "Speakap" }
- icon (entry level): The navigation icon shown next to the label in the menu.
Icon codes
Speakap uses unicode escape codes to define application menu icons. When converting hex codes, drop the 0x prefix and replace it with \u.
- Conversion formula: If the icon glyph code is 0xf0a1, write it as \uf0a1 in your manifest strings.
Still stuck?
Email us at technicalimplementations@speakap.nl with your network name and your manifest file, and we'll help you out.