HCAPP Bot API
HCAPP bot API is a separate API surface for external bots and AI agents.
It is intended for task creation, task reading, single-item updates, and file upload under a bot user.
Who can use it
- Only a user with role
BOT - Only with
Authorization: Bearer <token> - The token must belong to a user with role
BOT - The bot works within its form access scope
- Task operations are checked against
task.form_id
Base response envelope
Success:
json
{
"success": true,
"error_message": null,
"data": {}
}Error:
json
{
"success": false,
"error_message": "Form access not found",
"data": null
}Endpoints
GET /bot/auth/verifyPOST /bot/forms/{form_id}/tasksGET /bot/tasks/{task_id}PATCH /bot/tasks/{task_id}/items/{form_field_id}POST /bot/files/upload
All current bot endpoints use the success/error_message/data envelope.
Successful task creation returns 200, not 201.