Changelog
2025-03-29
New features
- Added Penalties API for extensions
- Extensions can now create habits (recurring or time-limited actions)
- New endpoints to manage penalties:
POST /api/extensions/sessions/:sessionId/penalties/increment
POST /api/extensions/sessions/:sessionId/penalties/time-limit/create
POST /api/extensions/sessions/:sessionId/penalties/time-limit/cancel
- Documentation: Penalties
2024-07-08
Minor changes
- Removed deprecated endpoint
POST /locks/shared-locks/:sharedLockId/archive
- For information, all routes starting with
/locks/shared-locks
are deprecated. - Please use the routes starting with
/shared-locks
instead.
- For information, all routes starting with
- Rate limits are now per user when using an OAuth token.
Bug fixes
- Fixed: The "Start timeout" option in extensions configuration is now working for cumulative mode.
- Fixed: Time updates are now provided to webhooks when time updates are hidden for the wearer.
2024-03-17
New features
- Added support for handlebars-helpers in configuration descriptions.
- You can now use handlebars helpers in the configuration description template.
- Documentation: Configuration page
- Added a custom helper for Handlebars templates
durationFromSeconds
: Convert a number of seconds to a human-readable duration- Documentation: Configuration page
Bug fixes
- Fixed: The field
availableHomeActions
is correctly marked as optional on the API documentation. - Fixed: Improved latency for endpoints using the developer token as authentication method.
2024-02-27
New features
- New endpoint
PATCH /api/extensions/sessions/{sessionId}
to update session information.- You can now update session config.
- You can now update session data, metadata using the
PATCH
method, instead of thePUT
methods.
- Following endpoints are now deprecated. Please use the new
PATCH
method instead.PUT /api/extensions/sessions/{sessionId}/metadata
PUT /api/extensions/sessions/{sessionId}/data
- Add basic authentication for webhooks
- Configure Basic HTTP authentication for your webhooks.
- When you configure a webhook, you can now provide a username and password.
Bug fixes
- Fixed: The provided configuration token was not valid when the user opened the configuration modal for another extension before.
- Fixed: Any update of a running session done by a keyholder was overriding the configuration of all external extensions, if the configuration modal has not been opened before.
- Fixed: The Discord
/lock
slash command was not working for locks with an external extension.
2024-01-16
New features
- Webhooks are now available for extensions.
- You can configure webhooks in the Developer interface.
- Available events:
extension_session.created
,extension_session.updated
,extension_session.deleted
,action_log.created
. - Documentation: Webhooks
- Resize the configuration iframe to the content height.
- The configuration iframe can now resize to the height of the content.
- You need to use the
iframe-resizer
library in your configuration page. - Documentation: Adapt the iframe height
- Added
geolocation
permission to the main and configuration pages.
Bug fixes
- Fixed: The configuration description template was not rendered in the lock extension settings.
2023-10-13
New features
- You can now modify the users who have access to your application.
- Users with access can use your private test extensions.
- You can add up to 20 accounts to an application.
2023-07-09: Extensions API Launch in Test Mode
Hi everyone! We're thrilled to announce that the Extensions API is now live in test mode. 🎉 You can access the complete documentation.
During this phase, we invite you to dive into the documentation, explore the API, and start building and testing your extensions. This is an exciting opportunity for you to unleash your creativity and integrate new features into the Chaster platform.
📚 Documentation and Feedback We encourage you to thoroughly review the documentation and provide us with your valuable feedback. If you encounter any bugs, missing features, or have suggestions for improvement, please don't hesitate to reach out. Your input will play a vital role in shaping the final version of the Extensions API.
🛠️ Test Mode and Limited Access During this test phase, extensions will be limited to test mode, meaning only you as the developer (and any limited users you choose) will be able to load and interact with your extensions. This allows you to experiment, fine-tune, and ensure everything works seamlessly before releasing to the wider Chaster community.
🚀 Next Steps If all goes well with testing and implementation, our plan is to officially release the Extensions API for public access in Q4. We're excited to see the first set of working extensions in action and witness the value they bring to the Chaster platform.
📩 Contact and Support For any questions, assistance, or when you're ready to request a review to validate your extension, our dedicated support channel is #api-support. Please create a thread per user and use it as your point of contact with our team. We'll be there to provide guidance, address queries, and help you throughout the process.
Thank you for being part of this journey as we expand the possibilities of Chaster with the Extensions API. We can't wait to see the innovative extensions you create!
Happy coding! 💪🚀