Custom Integration ⚙️
Overview
Custom integrations on Reworkly are services that use the Reworkly APIs to extend the functionality of Reworkly.
By building a custom integration app, you can keep user information in sync with an identity service, automate student and teacher registration , or automate posting to company announcement based on activity in another service.
Custom integrations are suitable for in-house development for your company (or bespoke development for the sole use of a single Reworkly customer).
If you have a different purpose, e.g., offering a SaaS or PaaS integration to multiple Reworkly customers, you should use Third Party Apps instead.
Do:
✅ Use custom integrations to make Reworkly a safer and more useful place to collaborate within your company
✅ Use custom integrations for bespoke development for the sole use of a single Reworkly customer
✅ Remain compliant with Reworkly's Platform Policies
Do not:
❌ Use Custom Integrations to offer a service that you host and operate on behalf of other Reworkly customers
❌ Use Custom Integrations to attempt to bypass Reworkly's app and security reviews
Creating an integration
Reworkly APIs are openly available APIs which can be called by any developer that knows how to call REST-based APIs. Access to these APIs is controlled by apps, with specific permissions and protected by access tokens.
Grant Permissions
As a Company admin, you can control the capabilities offered to each integration by creating apps and granting them specific permissions. Each app can be named to reflect the service it enables. Apps come with unique access tokens and permissions to control what information is allowed to be read or written by that app.
Access to Reworkly APIs
The REST API for Reworkly is a programmatic way to get data in and out of Reworkly. It's a low-level HTTP-based API that you can use to query data about resources in a Reworkly APIs.
Delete Integration
You can delete the integration. This action is not reversible and will delete the integration and its associated content.
Use Cases
As a Company admin, you can control the capabilities offered to each integration by creating apps and granting them specific permissions. Each app can be named to reflect the service it enables. Apps come with unique access tokens and permissions to control what information is allowed to be read or written by that app.