Summary: This guide explains how to integrate existing or custom software into your network using the Speakap API. It covers the technical setup for developers (the manifest.json file) and step-by-step instructions for network administrators to install an app and assign it to specific groups. You can find more information at developer.speakap.io.
What is a Speakap application?
A Speakap application is a web application, typically provided by a third party or custom-built, that is integrated into the Speakap platform to provide specific functionality (such as a to-do list or work schedule software).
Users access the application from Speakap's web or mobile apps, where it is embedded in an HTML iframe. Once integrated, developers can use various parts of the network:
- The Feed and widgets: apps can post automated Updates to feeds or display custom widgets (for example, a logged-in user's to-do list) next to the network Feed.
- The main menu: apps can be added directly to the main navigation menu with a custom label and icon (using the Font Awesome icon set).
- Users and groups: apps can use user profile data (names, avatars, job titles) and group data to streamline collaboration.
For developers: setting up and configuring the manifest
Before an administrator can install the app, the developer must configure the application.
Step 1: Registration. First, make sure you have access to a Speakap network. Register as a developer to make the Speakap Market tab available in your network settings.
Step 2: Configuring the manifest.json. Every application requires a manifest.json file, which specifies metadata about the application. The most generic information includes the name and icon, which are used to list the application in the Speakap Market.
The core of the manifest is formed by the definitions of the entries. At least one entry must be provided so the app is visible to users. Entries consist of:
- Positions: where the app appears. Options include main (the left-hand menu), network-timeline-widget (desktop homepage widgets), install-wizard (shown to admins during installation), settings-page (for post-install configuration), and *-lightbox (for loading custom lightbox content).
- Devices: the form factors the entry applies to (phone, tablet, desktop, or all).
- Properties: you can define the url (loaded via a signed request), required permissions, the user-visible label (which should include translations like "en-US"), and the icon.
For the full template and a reference of all properties, see Speakap Application Manifest Template and Properties.
For administrators: installing the application
Once the developer has prepared the application and the manifest.json URL, a network administrator can install it. To enter the Speakap Market you need an active Speakap account with an administrator role.
- Log in to your Speakap network.
- Click on your profile photo at the top right of the page.
- Click on Network Settings, then click on Speakap Market in the menu on the left.
- Click + Application at the top right of the screen.
- Select your desired application from the list, or copy-paste your custom app's manifest.json file.
- Click Add application.
- Click Install in network to install the application.
Assigning the application to specific groups. Applications can be installed for the entire network or for specific audiences, such as Business Units, Departments, or Groups:
- If you want the application to be visible only to certain members, click Select Groups at step 7 above.
- In the Select Groups screen, select the specific audience for the application.
- After selecting the desired groups, click Select to confirm.
Managing installed applications
Administrators can activate, deactivate, or edit Speakap applications at any time in the Speakap Market, found in the Network Settings. If the Speakap Market is not visible, ask your Customer Success Manager (csm@speakap.com) or email support@speakap.com to enable it for you.
Some applications, depending on how they were built, have a settings button (gear wheel next to the trash can). Click it to edit the app's settings. For questions about an application's settings, contact the developer of that application.
To remove an application later, see How to remove an application from the Speakap Market.
Still stuck?
Email us at support@speakap.com with your network name and the application name, and we'll help you out. For technical questions about the API or your manifest.json, email technicalimplementations@speakap.nl.