Webhook-Callback-Ereignisse
Erstellung von Konversationen
Wenn ein Benutzer durch Aufruf der API erfolgreich eine neue Konversation erstellt, empfängt die für den API-Kanal konfigurierte Webhook-URL ein Callback-Ereignis für die Konversationserstellung.
{
"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"
}
Parametertabelle für Ereignisse zur Konversationserstellung
| Field | Type | Required | Description |
|---|---|---|---|
| account | Object | No | Kontoinformationen des Projekts |
| account.id | Number | No | Projekt-ID |
| account.name | String | No | Projektname |
| additional_attributes | Object | No | Zusätzliche Attribute |
| can_reply | Boolean | No | Gibt an, ob Antworten erlaubt sind |
| channel | String | No | Kanaltyp, z. B. api oder email |
| contact_inbox | Object | No | Kontaktinformationen |
| contact_inbox.id | Number | No | Tabellen-ID von contact_inbox, die die Beziehung zwischen dem Kontakt und dem Kanal erfasst |
| contact_inbox.contact_id | Number | No | Kontakt-ID |
| contact_inbox.inbox_id | Number | No | Kanal-ID |
| contact_inbox.source_id | String | No | ID der Konversationsquelle, z. B. eine Telegram-user_id |
| contact_inbox.created_at | String | No | Erstellungszeit |
| contact_inbox.updated_at | String | No | Aktualisierungszeit |
| contact_inbox.hmac_verified | Boolean | No | Status der HMAC-Verifizierung |
| contact_inbox.pubsub_token | String | No | Publish-Subscribe-Token |
| id | Number | No | Konversations-ID |
| inbox_id | Number | No | Kanal-ID |
| messages | Array | No | Nachrichtenliste |
| labels | Array | No | Label-Liste |
| meta | Object | No | Metadaten |
| meta.sender | Object | No | Informationen zum Absender |
| meta.sender.additional_attributes | Object | No | Zusätzliche Attribute des Absenders |
| meta.sender.custom_attributes | Object | No | Benutzerdefinierte Attribute des Absenders |
| meta.sender.email | String | No | E-Mail-Adresse des Absenders |
| meta.sender.id | Number | No | Interne ID des Absenders in liveDesk |
| meta.sender.identifier | String | No | Absenderkennung |
| meta.sender.name | String | No | Name des Absenders |
| meta.sender.phone_number | String | No | Telefonnummer des Absenders |
| meta.sender.thumbnail | String | No | Avatar des Absenders |
| meta.sender.blocked | Boolean | No | Gibt an, ob der Absender blockiert ist |
| meta.sender.type | String | No | Absendertyp |
| meta.assignee | Object | No | Informationen zum zugewiesenen Kundendienstmitarbeiter |
| meta.team | Object | No | Informationen zum zugewiesenen Kundendienstteam |
| meta.hmac_verified | Boolean | No | Status der HMAC-Verifizierung |
| meta.channel | String | No | Kanaltyp |
| status | String | No | Konversationsstatus, z. B. open oder closed |
| custom_attributes | Object | No | Benutzerdefinierte Attribute |
| snoozed_until | String | No | Bis zu einem bestimmten Zeitpunkt zurückgestellt |
| unread_count | Number | No | Anzahl ungelesener Nachrichten |
| first_reply_created_at | String | No | Erstellungszeit der ersten Antwort |
| priority | String | No | Priorität |
| waiting_since | Number | No | Beginn der Wartezeit |
| conversation_category | String | No | Konversationskategorie |
| chat_mode | String | No | Chat-Modus |
| ticket_info | Object | No | Ticketinformationen |
| agent_last_seen_at | Number | No | Letzter Zeitpunkt, zu dem der Mitarbeiter die Konversation angesehen hat |
| contact_last_seen_at | Number | No | Letzter Zeitpunkt, zu dem der Kontakt die Konversation angesehen hat |
| last_activity_at | Number | No | Zeitpunkt der letzten Aktivität |
| timestamp | Number | No | Zeitstempel |
| created_at | Number | No | Erstellungszeit |
| updated_at | Number | No | Aktualisierungszeit |
| event | String | No | Ereignistyp |
Aktualisierung von Konversationen
Dieses Ereignis wird ausgelöst, wenn ein Attribut einer Konversation aktualisiert wird.
{
"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> Inhalt der Konversationsattribute
}
Parameter für Ereignisse zur Konversationsaktualisierung
| Field | Type | Required | Description |
|---|---|---|---|
| event | String | No | Ereignistyp |
| changed_attributes | Array | No | Liste der geänderten Attribute |
| changed_attributes.field_name | Object | No | Name des geänderten Feldes |
| changed_attributes.field_name.previous_value | String | No | Wert vor der Änderung |
| changed_attributes.field_name.current_value | String | No | Wert nach der Änderung |
Änderung des Konversationsstatus
Dieses Ereignis wird ausgelöst, wenn sich der Konversationsstatus ändert.
{
"event": "conversation_status_changed"
// <...Conversation Attributes> Inhalt der Konversationsattribute
}
Erstellung von Nachrichten
Dieses Ereignis wird ausgelöst, wenn ein Benutzer oder ein Kundendienstmitarbeiter eine Nachricht sendet.
{
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"content_attributes": {},
"content_type": "text",
"content": "How can I help you?",
"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": "How can I help you?",
"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": "How can I help you?",
"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"
}
Parametertabelle für Ereignisse zur Nachrichtenerstellung
| Field | Type | Required | Description |
|---|---|---|---|
| account | Object | No | Kontoinformationen |
| account.id | Number | No | Projekt-ID |
| account.name | String | No | Projektname |
| additional_attributes | Object | No | Zusätzliche Attribute |
| content_attributes | Object | No | Inhaltsattribute |
| content_type | String | No | Inhaltstyp |
| content | String | No | Nachrichteninhalt |
| conversation | Object | No | Konversationsinformationen |
| created_at | String | No | Erstellungszeit |
| id | Number | No | Nachrichten-ID |
| inbox | Object | No | Kanalinformationen |
| inbox.id | Number | No | Kanal-ID |
| inbox.name | String | No | Kanalname |
| message_type | String | No | Nachrichtentyp |
| conversation_topic_id | String | No | ID des Konversationsthemas |
| private | Boolean | No | Gibt an, ob die Nachricht privat ist |
| sender | Object | No | Informationen zum Absender |
| sender.id | Number | No | Absender-ID |
| sender.name | String | No | Name des Absenders |
| sender.email | String | No | E-Mail-Adresse des Absenders |
| sender.type | String | No | Absendertyp |
| sender.availability | String | No | Verfügbarkeitsstatus des Absenders |
| source_id | String | No | Quell-ID |
| participants | Object | No | Teilnehmerinformationen |
| event | String | No | Ereignistyp |
Aktualisierung von Nachrichten
Dieses Ereignis wird ausgelöst, wenn der Nachrichteninhalt in einer Konversation aktualisiert wird.
{
"event": "message_updated"
// <...Message Attributes> Inhalt der Nachrichtenattribute
}
Anheften von Nachrichten
Dieses Ereignis wird ausgelöst, wenn ein Kundendienstmitarbeiter eine Nachricht anheftet oder die Anheftung aufhebt.
{
"event": "message_pinned",
"id": 15680158,
"content": "hello11111 ",
"content_type": "text",
"message_type": "outgoing",
"private": false,
"source_type": "realtime",
"source_id": null,
"created_at": "2026-07-02T09:03:53.316Z",
"edited_at": "2026-07-02T09:04:02.791Z",
"pinned": true,
"pinned_at": "2026-07-02T09:04:23.748Z",
"pinned_by_id": 30,
"account": {
"id": 17829000004772,
"name": "11"
},
"inbox": {
"id": 228,
"name": "Test",
"channel_type": "Channel::Api"
},
"sender": {
"id": 30,
"name": "support",
"email": "TEST@support.cn",
"type": "user",
"availability": "online"
},
"conversation": {
"id": 202607000000002,
"inbox_id": 228,
"status": "open",
"channel_type": "Channel::Api",
"conversation_category": "chat",
"chat_mode": "private_chat",
"can_reply": true,
"unread_count": 0,
"last_activity_at": 1782983033,
"created_at": 1782982998,
"updated_at": 1782983063.750411,
"contact_inbox": {
"contact_id": 3939794,
"source_id": "5a6dbe3f-e7a7-4938-8364-1c3fe084e4a3"
},
"meta": {
"sender": {
"id": 3939794,
"name": "support11",
"email": "support11@engagelab.com",
"phone_number": "+123456111789",
"type": "contact"
},
"assignee": {
"id": 30,
"name": "TEST",
"type": "user"
}
}
}
}
Parametertabelle für Ereignisse zum Anheften von Nachrichten
| Field | Type | Required | Description |
|---|---|---|---|
| pinned | Boolean | No | Gibt an, ob die Nachricht angeheftet ist; true bedeutet angeheftet und false bedeutet nicht angeheftet |
| pinned_at | String | No | Zeitpunkt, zu dem die Nachricht angeheftet wurde; kann leer sein, wenn die Nachricht nicht angeheftet ist |
| pinned_by_id | Number | No | Kundendienst-ID, die die Anheftungsaktion ausgeführt hat |
| additional_attributes | Object | No | Zusätzliche Attribute |
| source_id | String | No | Quell-ID |
| participants | Object | No | Teilnehmerinformationen |
| event | String | No | Ereignistyp |
Bearbeitung von Nachrichten
Dieses Ereignis wird ausgelöst, wenn der Nachrichteninhalt bearbeitet wird. Beachten Sie, dass nur vom Kundendienstmitarbeiter gesendete Nachrichten bearbeitet werden können.
{
"event": "message_updated",
"id": 15680162,
"content": "Hello. How can I help you? ",
"content_type": "text",
"message_type": "outgoing",
"private": false,
"source_type": "realtime",
"source_id": null,
"created_at": "2026-07-02T10:32:51.420Z",
"edited_at": "2026-07-02T10:33:27.004Z",
"content_attributes": {
"edited_at": "2026-07-02T10:33:27.004Z"
},
"account": {
"id": 17829000004772,
"name": "11"
},
"inbox": {
"id": 228,
"name": "Test",
"channel_type": "Channel::Api"
},
"sender": {
"id": 30,
"name": "ye 88",
"type": "user"
},
"conversation": {
"id": 202607000000001,
"inbox_id": 228,
"status": "open",
"channel_type": "Channel::Api",
"conversation_category": "chat",
"chat_mode": "private_chat",
"can_reply": true,
"unread_count": 0,
"last_activity_at": 1782988371,
"created_at": 1782972594,
"updated_at": 1782988407.015933,
"contact_inbox": {
"contact_id": 3939794,
"source_id": "73e836b0-a893-41c2-b7e9-09a26a7332c8"
},
"messages": [
{
"id": 15680162,
"content": "Hello. How can I help you? ",
"inbox_id": 228,
"conversation_id": 202607000000001,
"message_type": 1,
"created_at": 1782988371,
"updated_at": "2026-07-02T10:33:27.013Z",
"private": false,
"status": "sent",
"source_id": null,
"content_type": "text",
"content_attributes": {
"edited_at": "2026-07-02T10:33:27.004Z"
},
"sender_type": "User",
"sender_id": 30,
"processed_message_content": "Hello. How can I help you? ",
"original_content": "Hello. ",
"source_type": "realtime",
"sender": {
"id": 30,
"name": "ye 88",
"type": "user"
}
}
]
}
}
Parametertabelle für Ereignisse zur Nachrichtenbearbeitung
| Field | Type | Required | Description |
|---|---|---|---|
| edited_at | String | No | Zeitpunkt der Bearbeitung des Inhalts |
| original_content | String | No | Ursprünglicher Inhalt vor der Bearbeitung |
| processed_message_content | String | No | Verarbeiteter Nachrichteninhalt |
Zurückziehen von Nachrichten
Dieses Ereignis wird ausgelöst, wenn ein Kundendienstmitarbeiter eine Nachricht zurückzieht.
{
"event": "message_revoked",
"id": 15680158,
"content": "hello11111 ",
"content_type": "text",
"message_type": "outgoing",
"private": false,
"source_type": "realtime",
"source_id": null,
"created_at": "2026-07-02T09:03:53.316Z",
"edited_at": "2026-07-02T09:04:02.791Z",
"revoked_at": "2026-07-02T09:05:10.918Z",
"revoked_by_id": 30,
"account": {
"id": 17829000004772,
"name": "11"
},
"inbox": {
"id": 228,
"name": "Test",
"channel_type": "Channel::Api"
},
"sender": {
"id": 30,
"name": "support",
"email": "TEST@Support.cn",
"type": "user",
"availability": "online"
},
"conversation": {
"id": 202607000000002,
"inbox_id": 228,
"status": "open",
"channel_type": "Channel::Api",
"conversation_category": "chat",
"chat_mode": "private_chat",
"can_reply": true,
"unread_count": 0,
"last_activity_at": 1782983033,
"created_at": 1782982998,
"updated_at": 1782983110.928425,
"contact_inbox": {
"contact_id": 3939794,
"source_id": "5a6dbe3f-e7a7-4938-8364-1c3fe084e4a3"
},
"meta": {
"sender": {
"id": 3939794,
"name": "support11",
"email": "support11@engagelab.com",
"phone_number": "+123456111789",
"type": "contact"
},
"assignee": {
"id": 30,
"name": "TEST",
"type": "user"
}
}
}
}
Parametertabelle für Ereignisse zum Zurückziehen von Nachrichten
| Field | Type | Required | Description |
|---|---|---|---|
| revoked_at | String | No | Zeitpunkt des Zurückziehens |
| revoked_by_id | String | No | Kundendienst-ID, die die Zurückziehungsaktion ausgeführt hat |










