Skip to main content

Endpoint

Authentication

This endpoint requires authentication via API key. Include your API key in the X-API-Key header:

Path Parameters

Request Body

The request body must be a JSON object with the following fields:

Required Fields

Optional Fields

Attachment Object

Each item in the attachments array must contain:

Request Example

Response

Success Response

Status Code: 200 OK

Response Fields

Error Responses

401 Unauthorized

Returned when authentication fails. See the authentication errors section for details.

404 Not Found

Returned when the task doesn’t exist or you don’t have access to it.

422 Validation Error

Returned when the request body is invalid or required fields are missing.

500 Internal Server Error

Returned when the comment creation fails due to a server error.

Notes

The activity_log_id returned in the response can be used as the reply_to value in subsequent requests to create threaded conversations on a task.
When a comment is posted, a flows.tasks.commented webhook event is triggered, allowing external systems to react to new comments in real time.
Attachments are sent as base64-encoded content in the request body. For large files, consider the impact on request size and timeout limits.

Use Cases

This endpoint is useful for:
  • Automated status updates - Post comments from external systems when events occur (e.g., approval from a third-party tool)
  • Threaded conversations - Build reply chains using the reply_to field with activity_log_id values
  • File sharing - Attach documents or reports to task comments programmatically
  • Cross-system notifications - Mention specific users to alert them about updates from integrated systems