Keep your users informed and engaged by managing product updates, collecting customer feedback, and sharing your public roadmap. You can use the Tasks API to seamlessly integrate these features directly into your own application, support portal, or internal dashboard.
Here is a high-level look at how these features flow together to create a continuous feedback loop:
flowchart LR
A["Customer Ideas"] -->|Reviewed & Approved| B["Public Roadmap"]
B -->|Developed & Released| C["Changelogs"]
C -->|Informs Users| AManaging Changelogs
Changelogs help you communicate new features, bug fixes, and improvements. You can retrieve your entire history of updates or fetch details for a specific release version.
| Action | Method | Endpoint | Description |
|---|---|---|---|
| List all changelogs | GET | /tasks/changelogs | Returns a paginated list of all published changelogs. |
| Get specific version | GET | /tasks/changelogs/version/{version_id} | Retrieves the release notes for a specific version ID. |
Example: Fetching a specific changelog version
curl https://api.yourdomain.com/v1/tasks/changelogs/version/v2.4.1
-H "Authorization: Bearer YOUR_API_KEY"Displaying changelogs directly inside your app (for example, in a "What's New" modal) significantly increases feature adoption and user awareness.
Collecting Customer Ideas
Listening to your users is the best way to build a product they love. You can programmatically submit customer ideas from your own forms or widgets.
- 1
Check your ideas configuration
Before submitting ideas, you might want to check your current configuration (like allowed categories or character limits).
curl https://api.yourdomain.com/v1/tasks/ideas/config -H "Authorization: Bearer YOUR_API_KEY" - 2
Submit a new idea
Send the customer's feedback to your workspace.
curl -X POST https://api.yourdomain.com/v1/tasks/ideas -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"title": "Dark Mode", "description": "Please add a dark theme!"}'
Public Roadmap & Voting
Sharing a public roadmap builds trust and shows users that the product is actively evolving. By allowing users to vote on roadmap items, you can prioritize development based on actual demand.
Fetching the Roadmap
To display your roadmap, retrieve the list of public items:
curl https://api.yourdomain.com/v1/tasks/roadmap
-H "Authorization: Bearer YOUR_API_KEY"Managing Votes
When a user clicks the "Upvote" button on your frontend, you can register their vote. If they change their mind, you can just as easily remove it.
| Action | Method | Endpoint |
|---|---|---|
| Add a vote | POST | /tasks/items/{item_id}/vote |
| Remove a vote | DELETE | /tasks/items/{item_id}/vote |
Ensure you are tracking user sessions or IDs on your frontend so that a single user cannot submit multiple votes for the same roadmap item.
Managing Support Tickets
In addition to tracking ideas and roadmap items, you can manage customer support tickets directly through the API. This allows you to unify user feedback and issue tracking within your organization.
| Action | Method | Endpoint |
|---|---|---|
| List support tickets | GET | /organization/{organization_id}/support/tickets |
| Create support ticket | POST | /organization/{organization_id}/support/tickets |
| Get support ticket | GET | /organization/{organization_id}/support/tickets/{ticket_id} |
| Add message to ticket | POST | /organization/{organization_id}/support/tickets/{ticket_id}/messages |
Frequently Asked Questions
Can I undo a vote if a user clicks by mistake?
Yes! Simply call the DELETE /tasks/items/{item_id}/vote endpoint for the specific roadmap item, and the vote count will be decremented.
Do I need to authenticate these requests?
Yes, all endpoints require a valid API key passed in the Authorization header. If you are calling these endpoints from a client-side application, we recommend routing them through your own backend to keep your API keys secure.