API changelog
complete
I
Ivory Crayfish
It would be great if now that the change log is out of Beta testing, it could be fetched via API request so that we could create our own change-log style widget with custom style on our sites.
Andrew Rasmussen
complete
You can now list your changelog entries via our API. https://developers.canny.io/api-reference#list_entries
This is a solid starting point, but let us know if you're looking for more advanced sorting/filtering, or additional endpoints.
Andrew Rasmussen
in progress
Working on it!
T
Tan Gecko
We would love to see this as well. We would like to build something similar to the changelog web widget for our mobile apps. Ie whenever we change something, let the users know. Three requirements for us would be:
- Fetch changelog posts (so we can display the title as a preview for example)
- A way to identify a specific changelog post so we know if the user has seen it or not
In the screenshot below, the button would simply open safari with our canny changelog. Or potentially open a new screen with a webview.
For a seamless experience we are thinking of first open our website, load the canny sdk, then redirect to our canny so we can get our users automatically logged in.
Andrew Rasmussen
Hey James, thanks for posting! I'm curious to hear, since the changelog entries are stored in markdown, how your team would want to handle that on your side? Would you actually build/integrate a markdown parser?
It seems like a lot of work, and I'm wondering if there's something we can do on our side to help out.
I
Ivory Crayfish
Andrew Rasmussen: Hi Andrew, even just the titles would help helpful, so that we could link to it and create our own version of the widget.
Otherwise, we could easily consume the markdown and convert with npm package Marked.
I guess in an ideal world, a ChangeLog entry would have:
- Title
- Short blurb
- Actual release notes
Then we could easily grab the title and short blurb and make our own widget.