Comment on a workflow or run

posthttps://api.expiryedge.com/v1/createWorkflowComment
bearer token (Firebase ID token or session JWT); any role60/minAny method
Request
curl -X POST 'https://api.expiryedge.com/v1/createWorkflowComment' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "workflow_id": "run_7Vb3",
  "step_id": "rstp_2Wd8",
  "content": "@Priya certificates for Dr. Lee are uploaded.",
  "mentioned_users": [
    {
      "id": "u_93kLp",
      "name": "Priya Shah"
    }
  ]
}'
Response
{
  "message": "Comment created successfully",
  "comment_id": "wcm_4Rt6",
  "comment": {
    "id": "wcm_4Rt6",
    "workflow_id": "run_7Vb3",
    "step_id": "rstp_2Wd8",
    "section_id": null,
    "user_id": "u_71bXq",
    "content": "@Priya certificates for Dr. Lee are uploaded.",
    "mentioned_users": [
      {
        "id": "u_93kLp",
        "name": "Priya Shah"
      }
    ],
    "is_edited": false,
    "created_at": "2026-09-27T14:05:00.000Z",
    "updated_at": "2026-09-27T14:05:00.000Z"
  }
}

workflow_id may be a workflow id or a workflow run id. Optionally scope the comment to a step or section. Mentioned users outside your organization are dropped; the rest get an in-app mention notification.

Body parameters

application/json
  • workflow_idstringrequired
    Workflow id or workflow run id.
  • contentstringrequired
  • step_idstring
  • section_idstring
  • mentioned_usersarray of objects

Returns

201
Created.
  • messagestringrequired
  • comment_idstringrequired
  • commentobjectrequired
    A comment on a workflow template or run. user_name and user_email are added when listed.

Errors

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Authenticated, but your role or organization does not allow this action.
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.