People Task
The People Task Appmixer module provides an API that lets you create tasks that can be approved or rejected by other people. This module is used by the appmixer.ui.PeopleTask UI SDK module in combination with the appmixer.utils.tasks.RequestApproval and appmixer.utils.tasks.RequestApprovalEmail components. Please see the People Tasks tutorial for more details.
Each task carries an email address of the requester and approver of the task together with title, description and due date. Tasks can have registered webhooks that the Appmixer engine calls when the status of the task changes (pending -> approved and pending -> rejected). Components can register these webhooks and trigger their outputs based on the result of the task resolution.
Get Tasks
GET
https://api.appmixer.com/people-task/tasks
Return all tasks of a user.
Query Parameters
Get Task Count
GET
https://api.appmixer.com/people-task/tasks-count
Get the number of all tasks of a user.
Query Parameters
Get Task
GET
https://api.appmixer.com/people-task/tasks/:id
Get a task detail.
Path Parameters
Create a New Task
POST
https://api.appmixer.com/people-task/tasks
Request Body
Register a Webhook for a Task
POST
https://api.appmixer.com/people-task/webhooks
Register a new webhook URL for a task. Appmixer will send a POST request to this URL whenever the status of the task changes. This is usually done right after creating a new task so that you can get notified as soon as the task gets approved or rejected.
Request Body
Delete a Webhook
GET
https://api.appmixer.com/people-task/webhooks/:id
Delete a previously registered webhook.
Path Parameters
Edit a Task
PUT
https://api.appmixer.com/people-task/tasks/:id
Edit an existing task.
Path Parameters
Request Body
Approve a Task
PUT
https://api.appmixer.com/people-task/tasks/:id/approve
This endpoint approves a task triggering all the registered webhooks for this task announcing a new approved
status.
Path Parameters
Request Body
Reject a Task
PUT
https://api.appmixer.com/people-task/tasks/:id/reject
This endpoint rejects a task triggering all the registered webhooks for this task announcing a new rejected
status.
Path Parameters
Request Body
Last updated