Create a session comment

curl --request POST \
  --url http://localhost:8080/chat/sessions/{session_id}/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "agent_id": 123,
  "attachments": [
    {
      "name": "<string>",
      "url": "<string>",
      "base64": "<string>",
      "mime_type": "<string>"
    }
  ]
}
'

import requests

url = "http://localhost:8080/chat/sessions/{session_id}/comments"

payload = {
    "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "content": "<string>",
    "agent_id": 123,
    "attachments": [
        {
            "name": "<string>",
            "url": "<string>",
            "base64": "<string>",
            "mime_type": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    thread_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    content: '<string>',
    agent_id: 123,
    attachments: [{name: '<string>', url: '<string>', base64: '<string>', mime_type: '<string>'}]
  })
};

fetch('http://localhost:8080/chat/sessions/{session_id}/comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/chat/sessions/{session_id}/comments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'thread_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'content' => '<string>',
    'agent_id' => 123,
    'attachments' => [
        [
                'name' => '<string>',
                'url' => '<string>',
                'base64' => '<string>',
                'mime_type' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/chat/sessions/{session_id}/comments"

	payload := strings.NewReader("{\n  \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"content\": \"<string>\",\n  \"agent_id\": 123,\n  \"attachments\": [\n    {\n      \"name\": \"<string>\",\n      \"url\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8080/chat/sessions/{session_id}/comments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"content\": \"<string>\",\n  \"agent_id\": 123,\n  \"attachments\": [\n    {\n      \"name\": \"<string>\",\n      \"url\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/chat/sessions/{session_id}/comments")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"content\": \"<string>\",\n  \"agent_id\": 123,\n  \"attachments\": [\n    {\n      \"name\": \"<string>\",\n      \"url\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "uuid": "<string>",
  "session_id": "<string>",
  "session_closed_payload": "<unknown>",
  "chatbot_id": "<string>",
  "from_user": true,
  "message": "<string>",
  "original_message": "<string>",
  "original_language": "<string>",
  "translated_message": "<string>",
  "translated_language": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "debug_json": {
    "v2": {
      "response": {
        "type": "prohibited_topic",
        "topic": "<string>"
      }
    },
    "actionCalls": [
      {
        "action": {
          "name": "<string>",
          "id": "<string>",
          "metadata": "<unknown>",
          "openapi": {
            "operation_spec": "<unknown>",
            "openapi_spec_id": "<string>",
            "operation_id": "<string>",
            "operation_method": "<string>"
          },
          "required_form_submission": true,
          "is_handoff_like": true
        },
        "arguments": "<unknown>",
        "result": "<unknown>"
      }
    ],
    "assignment_choice_summary": {
      "strategy": "least-busy",
      "selected": {
        "agent_id": 123,
        "agent_name": "<string>",
        "active_sessions": 123,
        "active_sessions_in_group": 123,
        "pending_sessions": 123,
        "remaining_capacity": 123,
        "max_capacity": 123,
        "max_capacity_in_group": 123,
        "is_available_globally": true,
        "is_available_in_group": true,
        "missing_required_skills": []
      },
      "peers": [
        {
          "agent_id": 123,
          "agent_name": "<string>",
          "active_sessions": 123,
          "active_sessions_in_group": 123,
          "pending_sessions": 123,
          "remaining_capacity": 123,
          "max_capacity": 123,
          "max_capacity_in_group": 123,
          "is_available_globally": true,
          "is_available_in_group": true,
          "missing_required_skills": []
        }
      ],
      "required_skills": []
    },
    "custom_data": {}
  },
  "knowledgebase_called": true,
  "extra_params": {},
  "agent_id": 123,
  "agent_name": "<string>",
  "agent_avatar": "<string>",
  "handoff_happened_during_office_hours": true,
  "sender_display_name": "<string>",
  "plan_executed": true,
  "contact_id": "<string>",
  "contact_name": "<string>",
  "contact_avatar_url": "<string>",
  "contact_slack_data": "<string>",
  "attachments": [
    {
      "id": "<string>",
      "name": "<string>",
      "size": 123,
      "type": "<string>",
      "url": "<string>",
      "openai_file_id": "<string>"
    }
  ],
  "email_rfc_message_id": "<string>",
  "email_to": [
    "<string>"
  ],
  "email_cc": [
    "<string>"
  ],
  "external_message_id": "<string>",
  "csat_score": 123,
  "csat_feedback": "<string>",
  "state_checkpoint_payload": null,
  "client_context": {},
  "workflow_id": "<string>",
  "workflow_run_id": "<string>",
  "sequence_id": "<string>",
  "whatsapp_template_name": "<string>",
  "whatsapp_template_snapshot": {
    "id": "<string>",
    "name": "<string>",
    "language": "<string>",
    "components": [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "<string>",
        "example": {
          "header_text": [
            "<string>"
          ]
        }
      }
    ],
    "rejected_reason": "<string>",
    "message_send_ttl_seconds": 0
  },
  "from_opencx_public_api": true,
  "sub_status_id": "<string>",
  "whatsapp_sent_at": "2023-11-07T05:31:56Z",
  "whatsapp_delivered_at": "2023-11-07T05:31:56Z",
  "whatsapp_read_at": "2023-11-07T05:31:56Z",
  "whatsapp_failed_at": "2023-11-07T05:31:56Z",
  "whatsapp_error_title": "<string>",
  "whatsapp_error_details": "<string>",
  "twitter_sent_at": "2023-11-07T05:31:56Z",
  "twitter_read_at": "2023-11-07T05:31:56Z",
  "twitter_failed_at": "2023-11-07T05:31:56Z",
  "twitter_error_title": "<string>",
  "twitter_error_details": "<string>",
  "agent_changed_payload": {
    "from": "ai",
    "to": "human_agent",
    "agent_id": 123
  },
  "comment_thread_id": "<string>",
  "edited_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "phone_call_id": "<string>",
  "phone_call": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "session_id": "<string>",
    "initiated_by_user_id": 123,
    "phone_agent_id": "<string>",
    "from_number": "<string>",
    "to_number": "<string>",
    "failure_reason": "<string>",
    "livekit_disconnect_reason": "<string>",
    "ring_started_at": "2023-11-07T05:31:56Z",
    "ring_expires_at": "2023-11-07T05:31:56Z",
    "accepted_by_user_id": 123,
    "answered_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "ended_by_user_id": 123,
    "duration_seconds": 123,
    "ring_duration_seconds": 123,
    "has_recording": true,
    "is_session_latest_call": true,
    "created_at": "2023-11-07T05:31:56Z",
    "events": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "phone_call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "actor_user_id": 123,
        "actor_name": "<string>",
        "detail": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

POST

chat

sessions

{session_id}

comments

Create a session comment

curl --request POST \
  --url http://localhost:8080/chat/sessions/{session_id}/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "agent_id": 123,
  "attachments": [
    {
      "name": "<string>",
      "url": "<string>",
      "base64": "<string>",
      "mime_type": "<string>"
    }
  ]
}
'

import requests

url = "http://localhost:8080/chat/sessions/{session_id}/comments"

payload = {
    "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "content": "<string>",
    "agent_id": 123,
    "attachments": [
        {
            "name": "<string>",
            "url": "<string>",
            "base64": "<string>",
            "mime_type": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    thread_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    content: '<string>',
    agent_id: 123,
    attachments: [{name: '<string>', url: '<string>', base64: '<string>', mime_type: '<string>'}]
  })
};

fetch('http://localhost:8080/chat/sessions/{session_id}/comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/chat/sessions/{session_id}/comments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'thread_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'content' => '<string>',
    'agent_id' => 123,
    'attachments' => [
        [
                'name' => '<string>',
                'url' => '<string>',
                'base64' => '<string>',
                'mime_type' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/chat/sessions/{session_id}/comments"

	payload := strings.NewReader("{\n  \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"content\": \"<string>\",\n  \"agent_id\": 123,\n  \"attachments\": [\n    {\n      \"name\": \"<string>\",\n      \"url\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8080/chat/sessions/{session_id}/comments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"content\": \"<string>\",\n  \"agent_id\": 123,\n  \"attachments\": [\n    {\n      \"name\": \"<string>\",\n      \"url\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/chat/sessions/{session_id}/comments")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"thread_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"content\": \"<string>\",\n  \"agent_id\": 123,\n  \"attachments\": [\n    {\n      \"name\": \"<string>\",\n      \"url\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"mime_type\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "uuid": "<string>",
  "session_id": "<string>",
  "session_closed_payload": "<unknown>",
  "chatbot_id": "<string>",
  "from_user": true,
  "message": "<string>",
  "original_message": "<string>",
  "original_language": "<string>",
  "translated_message": "<string>",
  "translated_language": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "debug_json": {
    "v2": {
      "response": {
        "type": "prohibited_topic",
        "topic": "<string>"
      }
    },
    "actionCalls": [
      {
        "action": {
          "name": "<string>",
          "id": "<string>",
          "metadata": "<unknown>",
          "openapi": {
            "operation_spec": "<unknown>",
            "openapi_spec_id": "<string>",
            "operation_id": "<string>",
            "operation_method": "<string>"
          },
          "required_form_submission": true,
          "is_handoff_like": true
        },
        "arguments": "<unknown>",
        "result": "<unknown>"
      }
    ],
    "assignment_choice_summary": {
      "strategy": "least-busy",
      "selected": {
        "agent_id": 123,
        "agent_name": "<string>",
        "active_sessions": 123,
        "active_sessions_in_group": 123,
        "pending_sessions": 123,
        "remaining_capacity": 123,
        "max_capacity": 123,
        "max_capacity_in_group": 123,
        "is_available_globally": true,
        "is_available_in_group": true,
        "missing_required_skills": []
      },
      "peers": [
        {
          "agent_id": 123,
          "agent_name": "<string>",
          "active_sessions": 123,
          "active_sessions_in_group": 123,
          "pending_sessions": 123,
          "remaining_capacity": 123,
          "max_capacity": 123,
          "max_capacity_in_group": 123,
          "is_available_globally": true,
          "is_available_in_group": true,
          "missing_required_skills": []
        }
      ],
      "required_skills": []
    },
    "custom_data": {}
  },
  "knowledgebase_called": true,
  "extra_params": {},
  "agent_id": 123,
  "agent_name": "<string>",
  "agent_avatar": "<string>",
  "handoff_happened_during_office_hours": true,
  "sender_display_name": "<string>",
  "plan_executed": true,
  "contact_id": "<string>",
  "contact_name": "<string>",
  "contact_avatar_url": "<string>",
  "contact_slack_data": "<string>",
  "attachments": [
    {
      "id": "<string>",
      "name": "<string>",
      "size": 123,
      "type": "<string>",
      "url": "<string>",
      "openai_file_id": "<string>"
    }
  ],
  "email_rfc_message_id": "<string>",
  "email_to": [
    "<string>"
  ],
  "email_cc": [
    "<string>"
  ],
  "external_message_id": "<string>",
  "csat_score": 123,
  "csat_feedback": "<string>",
  "state_checkpoint_payload": null,
  "client_context": {},
  "workflow_id": "<string>",
  "workflow_run_id": "<string>",
  "sequence_id": "<string>",
  "whatsapp_template_name": "<string>",
  "whatsapp_template_snapshot": {
    "id": "<string>",
    "name": "<string>",
    "language": "<string>",
    "components": [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "<string>",
        "example": {
          "header_text": [
            "<string>"
          ]
        }
      }
    ],
    "rejected_reason": "<string>",
    "message_send_ttl_seconds": 0
  },
  "from_opencx_public_api": true,
  "sub_status_id": "<string>",
  "whatsapp_sent_at": "2023-11-07T05:31:56Z",
  "whatsapp_delivered_at": "2023-11-07T05:31:56Z",
  "whatsapp_read_at": "2023-11-07T05:31:56Z",
  "whatsapp_failed_at": "2023-11-07T05:31:56Z",
  "whatsapp_error_title": "<string>",
  "whatsapp_error_details": "<string>",
  "twitter_sent_at": "2023-11-07T05:31:56Z",
  "twitter_read_at": "2023-11-07T05:31:56Z",
  "twitter_failed_at": "2023-11-07T05:31:56Z",
  "twitter_error_title": "<string>",
  "twitter_error_details": "<string>",
  "agent_changed_payload": {
    "from": "ai",
    "to": "human_agent",
    "agent_id": 123
  },
  "comment_thread_id": "<string>",
  "edited_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "phone_call_id": "<string>",
  "phone_call": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "session_id": "<string>",
    "initiated_by_user_id": 123,
    "phone_agent_id": "<string>",
    "from_number": "<string>",
    "to_number": "<string>",
    "failure_reason": "<string>",
    "livekit_disconnect_reason": "<string>",
    "ring_started_at": "2023-11-07T05:31:56Z",
    "ring_expires_at": "2023-11-07T05:31:56Z",
    "accepted_by_user_id": 123,
    "answered_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "ended_by_user_id": 123,
    "duration_seconds": 123,
    "ring_duration_seconds": 123,
    "has_recording": true,
    "is_session_latest_call": true,
    "created_at": "2023-11-07T05:31:56Z",
    "events": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "phone_call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "actor_user_id": 123,
        "actor_name": "<string>",
        "detail": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

Internal notes

Session comments are internal notes: agents see them in the inbox, the customer never does. A comment can be anchored two ways:

Attached to a message — pass thread_id, the UUID of the message being commented on. Message UUIDs come from Session History, where each event’s id is its message UUID.
Session-level — omit thread_id. The note stands on its own in the session timeline, not attached to any message.

agent_id is the numeric ID of the team member authoring the note.

Retrieving comments

Comments are part of the session timeline, so there is no separate list endpoint. Use Session History and filter for events where event.type is human_agent_comment. Each one carries the author (human_agent_id), the text (content.text), and the thread it belongs to (comment_thread_id).

Deep linking

You can link agents straight to a message or note in the dashboard inbox:

To a message: https://platform.open.cx/inbox/?s=<session_id>&h=<message_uuid>
To a comment on a message: https://platform.open.cx/inbox/?s=<session_id>&thread=<thread_id>&comment=<comment_uuid> — thread_id is the message the comment is attached to, and comment_uuid is the uuid returned when the comment is created.
To a session-level comment: https://platform.open.cx/inbox/?s=<session_id>&comment=<comment_uuid>&h=<comment_uuid> — the note is its own timeline row, so h targets the note itself.

The inbox opens the session and scrolls to the target.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_id

string

required

The unique identifier of the chat session

Body

application/json

thread_id

string<uuid>

required

Message UUID to comment on

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

content

string

required

Comment text content

Minimum string length: 1

agent_id

integer

required

Agent user ID that authors the comment

Required range: x <= 9007199254740991

attachments

object[]

Show child attributes

Response

Default Response

number

required

uuid

string

required

session_id

string

required

type

enum<string>

required

Available options:

agent_assigned_by_integration,

agent_assigned_by_system,

agent_assigned_by_user,

agent_changed,

agent_comment,

agent_initiated_session,

agent_joined,

agent_message,

agent_reopened_session,

agent_took_session_from_ai,

agent_unassigned_by_integration,

agent_unassigned_by_system,

agent_unassigned_by_user,

ai_assumed_the_session_resolved,

ai_decided_to_not_reply,

ai_decided_to_resolve_the_issue,

ai_reopened_session,

ai_response_cancelled,

ai_resumed_by_system,

call_history,

call_transferred,

closed_resolved_by_agent,

closed_resolved_by_api,

closed_resolved_by_contact,

closed_resolved_by_integration,

closed_resolved_by_system,

closed_unresolved_by_agent,

closed_unresolved_by_api,

closed_unresolved_by_system,

contact_data_updated,

csat_requested,

csat_submitted,

email_draft_message,

handoff,

handoff_to_salesforce_miaw,

handoff_to_zendesk,

integration_reopened_session,

message,

prohibited_topic_detected,

salesforce_fields_updated,

sequence_message,

session_forwarded,

skills_added_by_system,

sla_applied_by_agent,

sla_applied_by_system,

sla_first_reply_breached,

sla_first_reply_completed_after_breach,

sla_first_reply_fulfilled,

sla_first_reply_metric_started,

sla_freezed_office_hours_ended,

sla_freezed_snoozed,

sla_next_reply_breached,

sla_next_reply_completed_after_breach,

sla_next_reply_fulfilled,

sla_next_reply_metric_started,

sla_removed_by_agent,

sla_removed_by_system,

sla_resolution_breached,

sla_resolution_completed_after_breach,

sla_resolution_fulfilled,

sla_resolution_metric_started,

sla_resolution_paused_resolved,

sla_resolution_paused_waiting_on_customer,

sla_resolution_resumed_customer_replied,

sla_resolution_resumed_reopened,

sla_resumed_office_hours_started,

sla_resumed_snooze_cancelled,

sla_resumed_snooze_expired,

state_checkpoint,

sub_session_created,

sub_session_linked_by_agent,

sub_session_linked_by_api,

sub_session_linked_by_integration,

sub_session_linked_by_system,

sub_session_unlinked_by_agent,

sub_session_unlinked_by_api,

sub_session_unlinked_by_integration,

sub_session_unlinked_by_system,

sub_status_removed_by_agent,

sub_status_removed_by_api,

sub_status_removed_by_integration,

sub_status_removed_by_system,

sub_status_set_by_agent,

sub_status_set_by_api,

sub_status_set_by_integration,

sub_status_set_by_system,

system_reopened_session,

tag_added_by_agent,

tag_added_by_api,

tag_added_by_integration,

tag_added_by_system,

tag_removed_by_agent,

tag_removed_by_api,

tag_removed_by_integration,

tag_removed_by_system,

team_assigned_by_integration,

team_assigned_by_system,

team_assigned_by_user,

team_unassigned_by_integration,

team_unassigned_by_system,

team_unassigned_by_user,

user_confirmed_the_session_resolved,

workflow_message,

workflow_note,

workflow_triggered

session_closed_payload

any

required

chatbot_id

string | null

from_user

boolean | null

message

string | null

original_message

string | null

original_language

string | null

translated_message

string | null

translated_language

string | null

created_at

string<date-time> | null

updated_at

string<date-time> | null

debug_json

object

Option 1
Option 2

Show child attributes

knowledgebase_called

boolean | null

extra_params

object | null

Show child attributes

agent_id

number | null

agent_name

string | null

agent_avatar

string | null

handoff_happened_during_office_hours

boolean | null

sender_display_name

string | null

plan_executed

boolean | null

contact_id

string | null

contact_name

string | null

contact_avatar_url

string | null

contact_source

enum<string> | null

Available options:

csv,

form,

freshchat,

hubspot,

intercom,

pipedream,

salesforce,

slack

contact_slack_data

string | null

attachments

object[] | null

Show child attributes

email_rfc_message_id

string | null

email_to

string[] | null

email_cc

string[] | null

external_message_id

string | null

csat_score

number | null

csat_feedback

string | null

state_checkpoint_payload

unknown

client_context

object | null

Show child attributes

workflow_id

string | null

workflow_run_id

string | null

sequence_id

string | null

whatsapp_template_name

string | null

whatsapp_template_snapshot

object | null

Show child attributes

from_opencx_public_api

boolean | null

sub_status_id

string | null

whatsapp_sent_at

string<date-time> | null

whatsapp_delivered_at

string<date-time> | null

whatsapp_read_at

string<date-time> | null

whatsapp_failed_at

string<date-time> | null

whatsapp_error_title

string | null

whatsapp_error_details

string | null

twitter_sent_at

string<date-time> | null

twitter_read_at

string<date-time> | null

twitter_failed_at

string<date-time> | null

twitter_error_title

string | null

twitter_error_details

string | null

agent_changed_payload

object

Show child attributes

comment_thread_id

string | null

edited_at

string<date-time> | null

deleted_at

string<date-time> | null

phone_call_id

string | null

phone_call

object | null

Show child attributes

Overview

Blocklist

Autopilot

Organization

Contacts

Companies

Sessions

Connect

AI Phone Agents

AI Email

AI WhatsApp

AI Actions

AI Outbound Sequencing

Media

AI Training

Resource Usage

Customer Insights

Teams

CSAT

Redaction

Crawl

Tags

Office Hours

Handoff Analytics

SLA Analytics

Secrets

Workflows (Beta)

Salesforce MIAW

Webhooks

Create a session comment

Internal notes

Retrieving comments

Deep linking

Authorizations

Path Parameters

Body

Response

​Internal notes

​Retrieving comments

​Deep linking

Authorizations

Path Parameters

Body

Response

Internal notes

Retrieving comments

Deep linking