This article is meant for network administrators, in their role they can enter the Speakap Market.
Sometimes you wish to add menu items on Speakap, that link to external websites and make these menu items available for certain groups, business units, or local departments.
Please follow the below instructions to do so.
Do you want your menu item to be visible for your entire network? please check this article.
1) To add the menu item, you will need to create a manifest.json.
A manifest.json specifies meta-data about the application. Meta-data included are the name and icon used for listing the application in the Speakap Market and the entries by which the application can be accessed.
2) How to add the manifest.json in the Speakap Market? Check instructions here
3) This is a default template of a Manifest.json, that will:
- add a menu item on Speakap
- The URL will open in an external tab
- you will be able to select the groups to which the menu item will be made available
{
"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"
}
]
}
You can use the above manifest as a template. First, we’ll explain the different properties, what entries you can use, and how to use them from top to bottom of the manifest.
| Name | This is the name of the application, which you will see in the Speakap Market |
Replace Example_Name with the actual name of your application. Example:" |
| icon | This is the icon image that you can see in the application list of the Speakap Market | Replace REPLACE_WITH_ACTUAL_URL with the URL which leads to an image Example: "icon": "https://developer.speakap.io/content/themes/developer-portal/assets/images/sa-dev-logo-dark.svg", |
| url | This is the actual URL of the menu item |
Replace REPLACE_WITH_ACTUAL_URL with the URL which leads to the desired website. Example: |
| label | This is the name of the menu item, visible on the main menu of Speakap |
Replace Example_Name with the Menu item name Example: |
| icon | This is the icon on the main menu Click here for icon codes |
When the code = 0xf0a1 discard the 0x and Example: "icon": "\uf0a1" |