Use the automated flow method to build your seamless Knowledge Hub links when you want a scalable solution that has low service dependencies. This method is very scalable, but requires signature generation for individual links.
Knowledge Hubs are course libraries that help you organize courses by category. To ensure ease of use, Knowledge Hubs support search and priority courses. This allows learners to better understand the context, priorities, and progress.
What's Covered
Personalizing & signing seamless link
Embedding links within your app
Why build a Knowledge Hub
Knowledge Hubs are simpler to implement than building links to individual courses. Embed the Knowledge Hub in your application, to provide easy access and encourage continuous learning among your workforce.
Knowledge Hubs are designed to provide learners with an easy way to continue with the content they haven’t finished. Building a rich information repository that learners can access any time results in an empowered workforce, and subsequently leads to reduced need for internal support.
Building your Knowledge Hub
To generate an automated flow you need to get the relevant IDs from eduMe for the:
- Team ID for the team that the learner will be assigned to once they click the seamless link.
You can get these IDs from the admin panel, however this isn’t scalable as each time you want to add a new course or different type of content someone will have to get the ID to the development team to make changes.
We offer a couple of options for you to choose from:
- Webhooks - once set up these can send relevant IDs to your back end.
- Public APIs - once set up these can request IDs when you need them.
Webhook approach
Prerequisites
- You're an eduMe customer.
- You have a destination URL/data receiver (or multiple) for the webhooks to be sent to.
- You have technical or developer resources.
To enable webhooks, please reach out to your dedicated customer success manager, or contact our support team (support@edume.com), including the destination URL(s) you require.
Note: You can also activate learner level webhooks to support mandatory training flows. For more information, refer to our Webhooks document.
Procedure
Once webhooks have been enabled you can build a flow to automatically generate seamless links from the course level webhooks.
Public API approach
Prerequisites
- You're an eduMe customer with a company admin account.
- You have technical or developer resources.
Generating an API key
- Navigate to the API Keys page in your account using the following link: https://admin.edume.com/settings/developer-tools/api-keys. Alternatively, navigate to Settings in the top bar and choose Company Settings > API Key.
- Select + Create API Key.
- Select the Access level details and choose Create API Key.
You can now copy the API key you've created using the clipboard icon available on the right of the API key.
Public APIs can be used to request different kinds of data from eduMe. For seamless link generation you can call for:
-
Course details. Use the List course API to request course details.
Query parameter Source Group ID Use the Get Group Details with Teams API with the groupId parameter empty -
Team info. Use the Get Group Details with Teams API with groupId value in the query parameter.
Personalizing & signing seamless link
Generating signing secret
- Navigate to the Signing Secrets page in your account using the following link: https://admin.edume.com/settings/developer-tools/signing-secrets. Alternatively, navigate to Settings in the top bar and choose Company Settings > Signing Secrets.
- Select the clipboard next to your signing secret to copy.
Generating signature
-
Locate the URL for the relevant content. These links could’ve been shared when coordinating content creation. Refer to the Requirements for Seamless Links topic for more details.
-
Add your User ID as a query parameter.
-
Create signature of step 2 URL (SHA256 HMAC of secret and step 2 URL).
-
Add signature to URL as sig query parameter.
-
Store and share user-specific and signed URL as appropriate.
Here’s a sample code snippet (Node.js) for your reference:
import crypto from 'crypto';
const generateSignature = (urlWithUserId, secret) => {
return crypto
.createHmac('sha256', secret)
.update(urlWithUserId)
.digest('hex');
}
const courseId = 123;
const teamId = 5;
const userId = 'abc123';
// store more securely! (e.g. as an environment variable)
const secret = 'secret_from_edume';
const url = `https://learn.edume.com/e/d?g=${teamId}&e=${userId}`;
const signature = generateSignature(url, secret);
const finalUrl = `${url}&sig=${signature}`;
Branding
You can generate and use seamless links to direct learners to the Knowledge Hub. If you’d like to customize the Knowledge Hub to align with your brand, get in touch with your customer success manager with the following requirements:
- Header colors
- If you’d like to organize course card in To-do and Completed tabs
- The parameter you’d like to sort courses by - Course title or Last published
- Name of the course list
- Border radius
- Brand logo URL
- Style of the course card - with or without an image
Testing
In case of incorrect query parameters, your API request will return errors. If you receive a seamless link in the API response, the link should take you directly to the course.
Contact your customer success manager or our support team if your link does not direct you to the right place.
Embedding links within your app
Embed your Knowledge Hub in an accessible spot in your platform, where learners can quickly locate it. Additionally, we recommend sharing the link through communication tools - such as emails, SMS, in-app notifications - to encourage learners to access the Knowledge Hub.
Native mobile app
Load the seamless link URL within an in-app browser to enable easy navigation back to your app once the training is complete.
Web app
Load the seamless link within a new browser tab, allowing the user to navigate back to the web app once training is complete.