Skip to content
HeyX API

Add Problem Comment

Required scope: problem:comment

Add an internal note to a problem. The comment is text only, at most 20000 characters, and is not an outbound message to a customer. The API key creator must currently be authorized for the target problem, and the API key is mapped to its workspace member as the comment author.

Generated Reference
POST /public-api/publicapi.v1.Problem/AddProblemComment

Appends a plain-text comment attributed to the API key actor's member and notifies the problem's subscribers. This operation is not idempotent.

Request AddProblemCommentRequest
Response AddProblemCommentResponse

AddProblemCommentRequest

Field Type Description
problem_id string Identifies the target problem. Must be visible to the API key actor.
text string Plain-text comment body. Mentions and markdown are not interpreted.

AddProblemCommentResponse

Field Type Description
comment ProblemComment The comment that was created.

Related Types

ProblemComment

Field Type Description
id string Unique identifier of the created comment.
text string Plain-text body as stored.
created_at int64 Creation time in Unix seconds.

Request

Section titled “Request”
{
  "problemId": "<problem-id>",
  "text": "Called the site contact; access confirmed for Tuesday."
}

Response

Section titled “Response”
{
  "comment": {
    "id": "<comment-id>",
    "text": "Called the site contact; access confirmed for Tuesday.",
    "createdAt": 1758000000
  }
}

This is not idempotent; do not blindly retry a timed-out call, as it may still have created the comment.

HeyX API