My tasks API
All Zenya modules generate tasks and/or notifications for users. Tasks require the user to take action. Notifications are informational.
The Zenya REST API can be used to retrieve a list of tasks and a list of notifications for a user.
Most tasks will include an action link, which is a deeplink into a Zenya module to the screen where the user can actually perform the task (for example: review a document). Zenya also supports light-weight tasks which can be finished by a single click. The REST API supports creating and finishing such tasks.
Older API’s based on WCF and SOAP are also still available for retrieval of basic information about tasks. Both the WCF and the SOAP API are deprecated and will loose support in Q2 2022.
- Use the tasks route to retrieve the list of tasks for a user.
- Use the notification route to retrieve the list of notifications for a user.
- Use the tasks route to interact with tasks which support it.
In general, tasks which contain action links cannot be completed via the API. The action link has to be presented to the user, and the task will automatically be completed when user performs the action which the link leads him to.
Note that tasks and notifications can be retrieved for a person, but also for a team.
General API usage information
Overview of important information for consumers of the Zenya REST API, with topics like versioning, verbs, status codes, authentication and error handling.
Overview of changes and announced deprecations regarding the Zenya REST API.
Our code samples on GitHub show you how to get started with the Zenya REST API.
A detailed reference for this API is provided in Swagger format.
Please note that the Swagger reference is also present in each customer’s Zenya tenant. You can find it by adding /api to the URL of the customer’s Zenya tenant. For example: https://organisation.zenya.work/api
In order to interact with the Swagger reference, you need to access the Swagger in the customer’s Zenya, and you need valid credentials for the customer’s Zenya.