Summary: This guide is for developers, IT architects, and systems integrators who want to build custom applications, connect external software, or automate workflows with the Speakap API. It points you to the official developer documentation and gives an overview of what the API can do.
Where to find the technical documentation
The primary place for planning, building, and deploying custom integrations is the Speakap Developer Portal at developer.speakap.io. There you can browse live sample payloads, view up-to-date endpoint paths, and follow code tutorials.
Core capabilities of the Speakap API
The developer portal provides extensive, interactive references for our RESTful public API. You can use it to build bidirectional data syncs across the core objects in Speakap:
- Users: Provision user data, retrieve unique 64-bit hexadecimal Identifiers (EIDs), and audit employee profiles. Note: an EID is not the same as an XID. An EID is the internal identifier used within Speakap, while an XID is the external identifier that links a user in Speakap to an external system, such as an HR database.
- Groups: Map basic, restricted, private, or hierarchical organizational groups to match your internal company structure.
- Messages: Query resources including updates on the Feed, comments, private chat messages, news items, and file uploads.
- Notifications: Send custom push notifications and trigger user alerts when important events happen in third-party systems.
Authentication, manifests, and app deployment
To protect your network's data from unauthorized use, all custom features connect through standard security and configuration layers:
- OAuth 2.0: Applications authorize requests using short-lived Access Tokens and long-term Refresh Tokens, managed through the central Speakap Authenticator.
- JSON application manifests: Developers define integration points, permission sets, and UI placement by uploading a standard manifest.json definition file.
- The Speakap Market: Once an internal tool is verified, a network admin can log in on a desktop browser and install the application through the App Market tab in Network Settings. The app can be visible only to your own organization, or published globally to the public Speakap Market.
Frequently asked questions
Where can I find the official Speakap API documentation and OpenAPI specifications?
You can explore the endpoint schemas and download the latest version of our public OpenAPI definition in the Speakap Developer Portal.
What authentication standard does the platform use to secure third-party integrations?
Speakap uses the industry-standard OAuth 2.0 protocol paired with signed requests to securely authenticate client connections, passing tokens to identify API actions on behalf of apps or users.
How do I deploy a custom application to our network?
Build your application using the JSON app manifest guidelines on the developer portal. Once it is ready, a network admin can log in on a desktop browser and install it through the App Market tab in Network Settings.
What are EIDs and how are they used?
An EID is an internal identifier represented as a unique hexadecimal 64-bit integer assigned to every individual object in the system database. You supply these EIDs in your API request headers and query parameters to look up or update items such as specific user records or news items. In contrast, an XID is the external identifier used to link a user in Speakap to an external system, such as an HR database.
Still stuck?
Email us at technicalimplementations@speakap.nl with your network name and a description of what you are building, and we'll help you out.