Skip to main content
Create a comment event
curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/5/cases/cases/v1/{case_id}/comments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "This is updated text",
  "attachments": [
    {
      "customWidget": {
        "customDashboardId": "dashboard_3f166e9f-3c88-4af2-b52e-138f339dab3e",
        "widgetId": "widget_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "widgetScreenshot": {
          "fileId": "file_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "fileName": "screenshot_2025-09-22.png",
          "isDeleted": false
        },
        "queryLinkSuffix": "/dashboards/custom/123/widgets/456?time=123456789"
      }
    }
  ]
}
'
{
  "event": {
    "actor": {
      "apiKey": {
        "id": "2b1c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e",
        "name": "Incident Management Integration Key"
      }
    },
    "createTime": "2025-09-22T10:30:00.000Z",
    "eventData": {
      "assigned": {
        "assigneeUserId": "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0",
        "previousAssigneeUserId": "<string>"
      }
    },
    "eventId": "ef51d3d9-a301-496b-aa7d-9a6e519ba0d5",
    "eventTime": "2025-09-22T10:29:45.000Z",
    "updateTime": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.coralogix.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

case_id
string
required

ID of the case to add the event to. Accepts either the case UUID (the id field on a case) or the readable identifier (the readable_id field, e.g. CASE-123).

Required string length: 1 - 64
Pattern: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$
Example:

"3f166e9f-3c88-4af2-b52e-138f339dab3e"

Body

application/json

Request for creating a comment on a case.

text
string
required

Comment text to update

Example:

"This is updated text"

attachments
Comment attachment · object[]

Attachments to the comment

Response

Response returned after successfully creating a comment.

event
Case event · object
required

Represents an immutable entry in a case's event timeline.