Webhook Events
会話の作成
ユーザーが API を呼び出して新しい会話を正常に作成すると、API チャネルに設定された webhook アドレスが会話作成コールバックイベントを受け取ります。
{
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"can_reply": true,
"channel": "Channel::Api",
"contact_inbox": {
"id": 42213404,
"contact_id": 42218348,
"inbox_id": 523,
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588",
"created_at": "2026-01-21T03:26:49.012Z",
"updated_at": "2026-01-21T03:26:49.012Z",
"hmac_verified": false,
"pubsub_token": "4Urn7N5A974k6C2H7Xeva8Ni"
},
"id": 89,
"inbox_id": 523,
"messages": [],
"labels": [],
"meta": {
"sender": {
"additional_attributes": {},
"custom_attributes": {},
"email": "alice@acme.inc",
"id": 42218348,
"identifier": null,
"name": "Test",
"phone_number": "+123456789",
"thumbnail": "",
"blocked": false,
"type": "contact"
},
"assignee": null,
"team": null,
"hmac_verified": false,
"channel": "Channel::Api"
},
"status": "open",
"custom_attributes": {},
"snoozed_until": null,
"unread_count": 0,
"first_reply_created_at": null,
"priority": null,
"waiting_since": 1768967324,
"conversation_category": "chat",
"chat_mode": "private_chat",
"ticket_info": null,
"agent_last_seen_at": 0,
"contact_last_seen_at": 0,
"last_activity_at": 1768967324,
"timestamp": 1768967324,
"created_at": 1768967324,
"updated_at": 1768967324.268219,
"event": "conversation_created"
}
{
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"can_reply": true,
"channel": "Channel::Api",
"contact_inbox": {
"id": 42213404,
"contact_id": 42218348,
"inbox_id": 523,
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588",
"created_at": "2026-01-21T03:26:49.012Z",
"updated_at": "2026-01-21T03:26:49.012Z",
"hmac_verified": false,
"pubsub_token": "4Urn7N5A974k6C2H7Xeva8Ni"
},
"id": 89,
"inbox_id": 523,
"messages": [],
"labels": [],
"meta": {
"sender": {
"additional_attributes": {},
"custom_attributes": {},
"email": "alice@acme.inc",
"id": 42218348,
"identifier": null,
"name": "Test",
"phone_number": "+123456789",
"thumbnail": "",
"blocked": false,
"type": "contact"
},
"assignee": null,
"team": null,
"hmac_verified": false,
"channel": "Channel::Api"
},
"status": "open",
"custom_attributes": {},
"snoozed_until": null,
"unread_count": 0,
"first_reply_created_at": null,
"priority": null,
"waiting_since": 1768967324,
"conversation_category": "chat",
"chat_mode": "private_chat",
"ticket_info": null,
"agent_last_seen_at": 0,
"contact_last_seen_at": 0,
"last_activity_at": 1768967324,
"timestamp": 1768967324,
"created_at": 1768967324,
"updated_at": 1768967324.268219,
"event": "conversation_created"
}
このコードブロックはフローティングウィンドウ内に表示されます
会話作成イベントパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| account | Object | No | アカウントプロジェクト情報 |
| id | Number | No | プロジェクトID |
| name | String | No | プロジェクト名 |
| additional_attributes | Object | No | 追加属性 |
| can_reply | Boolean | No | 返信が可能かどうか |
| channel | String | No | チャネルタイプ、例えばapi、emailなど |
| contact_inbox | Object | No | コンタクト情報 |
| id | Number | No | contact_inboxテーブルID、コンタクトとチャネルの関係を記録 |
| contact_id | Number | No | コンタクトID |
| inbox_id | Number | No | チャネルID |
| source_id | String | No | 会話ソースID、例えばTelegramのuser_id |
| created_at | String | No | 作成時間 |
| updated_at | String | No | 更新時間 |
| hmac_verified | Boolean | No | HMAC検証ステータス |
| pubsub_token | String | No | パブリッシュサブスクライブトークン |
| id | Number | No | 会話ID |
| inbox_id | Number | No | チャネルID |
| messages | Array | No | メッセージリスト |
| labels | Array | No | ラベルリスト |
| meta | Object | No | メタ情報 |
| sender | Object | No | 送信者情報 |
| additional_attributes | Object | No | 送信者の追加属性 |
| custom_attributes | Object | No | 送信者のカスタム属性 |
| String | No | 送信者のメール | |
| id | Number | No | liveDesk内の送信者の内部ID |
| identifier | String | No | 送信者識別子 |
| name | String | No | 送信者名 |
| phone_number | String | No | 送信者の電話番号 |
| thumbnail | String | No | 送信者のアバター |
| blocked | Boolean | No | 送信者がブロックされているかどうか |
| type | String | No | 送信者タイプ |
| assignee | Object | No | 割り当てられたカスタマーサービスエージェント情報 |
| team | Object | No | 割り当てられたカスタマーサービスチーム情報 |
| hmac_verified | Boolean | No | HMAC検証ステータス |
| channel | String | No | チャネルタイプ |
| status | String | No | 会話ステータス、例えばopen、closedなど |
| custom_attributes | Object | No | カスタム属性 |
| snoozed_until | String | No | 特定の時間までスヌーズ |
| unread_count | Number | No | 未読メッセージ数 |
| first_reply_created_at | String | No | 最初の返信作成時間 |
| priority | String | No | 優先度 |
| waiting_since | Number | No | 待機開始時間 |
| conversation_category | String | No | 会話カテゴリ |
| chat_mode | String | No | チャットモード |
| ticket_info | Object | No | チケット情報 |
| agent_last_seen_at | Number | No | エージェントの最終確認時間 |
| contact_last_seen_at | Number | No | コンタクトの最終確認時間 |
| last_activity_at | Number | No | 最終アクティビティ時間 |
| timestamp | Number | No | タイムスタンプ |
| created_at | Number | No | 作成時間 |
| updated_at | Number | No | 更新時間 |
| event | String | No | イベントタイプ |
会話の更新
会話内の属性が更新されると、このイベントがトリガーされます。
{
"event": "conversation_updated",
"changed_attributes": [
{
"updated_at": {
"previous_value": "2026-01-21T04:04:56.548Z",
"current_value": "2026-01-21T04:04:56.601Z"
}
},
{
"first_reply_created_at": {
"previous_value": null,
"current_value": "2026-01-21T04:04:56.544Z"
}
},
{
"waiting_since": {
"previous_value": "2026-01-21T03:48:44.268Z",
"current_value": null
}
}
]
// <...Conversation Attributes> 会話の属性コンテンツ
}
{
"event": "conversation_updated",
"changed_attributes": [
{
"updated_at": {
"previous_value": "2026-01-21T04:04:56.548Z",
"current_value": "2026-01-21T04:04:56.601Z"
}
},
{
"first_reply_created_at": {
"previous_value": null,
"current_value": "2026-01-21T04:04:56.544Z"
}
},
{
"waiting_since": {
"previous_value": "2026-01-21T03:48:44.268Z",
"current_value": null
}
}
]
// <...Conversation Attributes> 会話の属性コンテンツ
}
このコードブロックはフローティングウィンドウ内に表示されます
会話更新イベントパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| event | String | No | イベントタイプ |
| changed_attributes | Array | No | 変更された属性リスト |
| field_name | Object | No | 変更されたフィールド名 |
| previous_value | String | No | 変更前の値 |
| current_value | String | No | 変更後の値 |
会話ステータスの変更
会話のステータスが変更されると、このイベントがトリガーされます。
{
"event": "conversation_status_changed"
// <...Conversation Attributes> 会話の属性コンテンツ
}
{
"event": "conversation_status_changed"
// <...Conversation Attributes> 会話の属性コンテンツ
}
このコードブロックはフローティングウィンドウ内に表示されます
メッセージの作成
ユーザーまたはカスタマーサービスがメッセージを送信すると、このイベントがトリガーされます。
{
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"content_attributes": {},
"content_type": "text",
"content": "こんにちは、どのようにお手伝いできますか？",
"conversation": {
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"can_reply": true,
"channel": "Channel::Api",
"contact_inbox": {
"id": 42213404,
"contact_id": 42218348,
"inbox_id": 523,
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588",
"created_at": "2026-01-21T03:26:49.012Z",
"updated_at": "2026-01-21T03:26:49.012Z",
"hmac_verified": false,
"pubsub_token": "4Urn7N5A974k6C2H7Xeva8Ni"
},
"id": 89,
"inbox_id": 523,
"messages": [
{
"id": 2187685,
"content": "こんにちは、どのようにお手伝いできますか？",
"account_id": 17629000001207,
"inbox_id": 523,
"conversation_id": 89,
"message_type": 1,
"created_at": 1768968296,
"updated_at": "2026-01-21T04:04:56.544Z",
"private": false,
"status": "sent",
"source_id": null,
"content_type": "text",
"content_attributes": {},
"sender_type": "User",
"sender_id": 41,
"external_source_ids": {},
"additional_attributes": {},
"processed_message_content": "こんにちは、どのようにお手伝いできますか？",
"sentiment": {},
"sorting_id": null,
"original_message_id": null,
"conversation_topic_id": null,
"topic_id": null,
"conversation": {
"assignee_id": null,
"unread_count": 0,
"last_activity_at": 1768968296,
"contact_inbox": {
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588"
}
},
"sender": {
"id": 41,
"name": "support",
"available_name": "support",
"avatar_url": "",
"type": "user",
"availability_status": null,
"thumbnail": ""
}
}
],
"labels": [],
"meta": {
"sender": {
"additional_attributes": {},
"custom_attributes": {},
"email": "alice@acme.inc",
"id": 42218348,
"identifier": null,
"name": "Test",
"phone_number": "+123456789",
"thumbnail": "",
"blocked": false,
"type": "contact"
},
"assignee": null,
"team": null,
"hmac_verified": false,
"channel": "Channel::Api"
},
"status": "open",
"custom_attributes": {},
"snoozed_until": null,
"unread_count": 0,
"first_reply_created_at": null,
"priority": null,
"waiting_since": 1768967324,
"conversation_category": "chat",
"chat_mode": "private_chat",
"ticket_info": null,
"agent_last_seen_at": 0,
"contact_last_seen_at": 0,
"last_activity_at": 1768968296,
"timestamp": 1768968296,
"created_at": 1768967324,
"updated_at": 1768968296.5483441
},
"created_at": "2026-01-21T04:04:56.544Z",
"id": 2187685,
"inbox": {
"id": 523,
"name": "Test01"
},
"message_type": "outgoing",
"conversation_topic_id": null,
"private": false,
"sender": {
"id": 41,
"name": "support",
"email": "support@jiguang.cn",
"type": "user",
"availability": "online"
},
"source_id": null,
"user_id": 42213404,
"contact_id": 42218348,
"participants": null,
"event": "message_created"
}
{
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"content_attributes": {},
"content_type": "text",
"content": "こんにちは、どのようにお手伝いできますか？",
"conversation": {
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"can_reply": true,
"channel": "Channel::Api",
"contact_inbox": {
"id": 42213404,
"contact_id": 42218348,
"inbox_id": 523,
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588",
"created_at": "2026-01-21T03:26:49.012Z",
"updated_at": "2026-01-21T03:26:49.012Z",
"hmac_verified": false,
"pubsub_token": "4Urn7N5A974k6C2H7Xeva8Ni"
},
"id": 89,
"inbox_id": 523,
"messages": [
{
"id": 2187685,
"content": "こんにちは、どのようにお手伝いできますか？",
"account_id": 17629000001207,
"inbox_id": 523,
"conversation_id": 89,
"message_type": 1,
"created_at": 1768968296,
"updated_at": "2026-01-21T04:04:56.544Z",
"private": false,
"status": "sent",
"source_id": null,
"content_type": "text",
"content_attributes": {},
"sender_type": "User",
"sender_id": 41,
"external_source_ids": {},
"additional_attributes": {},
"processed_message_content": "こんにちは、どのようにお手伝いできますか？",
"sentiment": {},
"sorting_id": null,
"original_message_id": null,
"conversation_topic_id": null,
"topic_id": null,
"conversation": {
"assignee_id": null,
"unread_count": 0,
"last_activity_at": 1768968296,
"contact_inbox": {
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588"
}
},
"sender": {
"id": 41,
"name": "support",
"available_name": "support",
"avatar_url": "",
"type": "user",
"availability_status": null,
"thumbnail": ""
}
}
],
"labels": [],
"meta": {
"sender": {
"additional_attributes": {},
"custom_attributes": {},
"email": "alice@acme.inc",
"id": 42218348,
"identifier": null,
"name": "Test",
"phone_number": "+123456789",
"thumbnail": "",
"blocked": false,
"type": "contact"
},
"assignee": null,
"team": null,
"hmac_verified": false,
"channel": "Channel::Api"
},
"status": "open",
"custom_attributes": {},
"snoozed_until": null,
"unread_count": 0,
"first_reply_created_at": null,
"priority": null,
"waiting_since": 1768967324,
"conversation_category": "chat",
"chat_mode": "private_chat",
"ticket_info": null,
"agent_last_seen_at": 0,
"contact_last_seen_at": 0,
"last_activity_at": 1768968296,
"timestamp": 1768968296,
"created_at": 1768967324,
"updated_at": 1768968296.5483441
},
"created_at": "2026-01-21T04:04:56.544Z",
"id": 2187685,
"inbox": {
"id": 523,
"name": "Test01"
},
"message_type": "outgoing",
"conversation_topic_id": null,
"private": false,
"sender": {
"id": 41,
"name": "support",
"email": "support@jiguang.cn",
"type": "user",
"availability": "online"
},
"source_id": null,
"user_id": 42213404,
"contact_id": 42218348,
"participants": null,
"event": "message_created"
}
このコードブロックはフローティングウィンドウ内に表示されます
メッセージ作成イベントパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
| account | Object | No | アカウント情報 |
| id | Number | No | プロジェクトID |
| name | String | No | プロジェクト名 |
| additional_attributes | Object | No | 追加属性 |
| content_attributes | Object | No | コンテンツ属性 |
| content_type | String | No | コンテンツタイプ |
| content | String | No | メッセージコンテンツ |
| conversation | Object | No | 会話情報 |
| created_at | String | No | 作成時間 |
| id | Number | No | メッセージID |
| inbox | Object | No | チャネル情報 |
| id | Number | No | チャネルID |
| name | String | No | チャネル名 |
| message_type | String | No | メッセージタイプ |
| conversation_topic_id | String | No | 会話トピックID |
| private | Boolean | No | プライベートかどうか |
| sender | Object | No | 送信者情報 |
| id | Number | No | 送信者ID |
| name | String | No | 送信者名 |
| String | No | 送信者のメール | |
| type | String | No | 送信者タイプ |
| availability | String | No | 送信者の可用性ステータス |
| source_id | String | No | ソースID |
| user_id | Number | No | ユーザーID |
| contact_id | Number | No | コンタクトID |
| participants | Object | No | 参加者情報 |
| event | String | No | イベントタイプ |
メッセージの更新
会話内のメッセージコンテンツが更新されると、このイベントがトリガーされます。
{
"event": "message_updated"
// <...Message Attributes> メッセージの属性コンテンツ
}
{
"event": "message_updated"
// <...Message Attributes> メッセージの属性コンテンツ
}
このコードブロックはフローティングウィンドウ内に表示されます
