Webhook Events

Conversation Created

When a user successfully creates a new conversation by calling the API, the webhook address configured for the API channel will receive a conversation creation callback event.

{ "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"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Conversation Creation Event Parameters

Field	Type	Required	Description
account	Object	No	Account project information
id	Number	No	Project ID
name	String	No	Project name
additional_attributes	Object	No	Additional attributes
can_reply	Boolean	No	Whether replying is possible
channel	String	No	Channel type, such as api, email, etc.
contact_inbox	Object	No	Contact information
id	Number	No	contact_inbox table id, records the relationship between contact and channel
contact_id	Number	No	Contact ID
inbox_id	Number	No	Channel ID
source_id	String	No	Conversation source ID, such as Telegram's user_id
created_at	String	No	Creation time
updated_at	String	No	Update time
hmac_verified	Boolean	No	HMAC verification status
pubsub_token	String	No	Publish-subscribe token
id	Number	No	Conversation ID
inbox_id	Number	No	Channel ID
messages	Array	No	Message list
labels	Array	No	Label list
meta	Object	No	Meta information
sender	Object	No	Sender information
additional_attributes	Object	No	Sender additional attributes
custom_attributes	Object	No	Sender custom attributes
email	String	No	Sender email
id	Number	No	Sender's internal ID in liveDesk
identifier	String	No	Sender identifier
name	String	No	Sender name
phone_number	String	No	Sender phone number
thumbnail	String	No	Sender avatar
blocked	Boolean	No	Whether the sender is blocked
type	String	No	Sender type
assignee	Object	No	Assigned customer service agent information
team	Object	No	Assigned customer service team information
hmac_verified	Boolean	No	HMAC verification status
channel	String	No	Channel type
status	String	No	Conversation status, such as open, closed, etc.
custom_attributes	Object	No	Custom attributes
snoozed_until	String	No	Snoozed until a certain time
unread_count	Number	No	Unread message count
first_reply_created_at	String	No	First reply creation time
priority	String	No	Priority
waiting_since	Number	No	Waiting start time
conversation_category	String	No	Conversation category
chat_mode	String	No	Chat mode
ticket_info	Object	No	Ticket information
agent_last_seen_at	Number	No	Agent last seen time
contact_last_seen_at	Number	No	Contact last seen time
last_activity_at	Number	No	Last activity time
timestamp	Number	No	Timestamp
created_at	Number	No	Creation time
updated_at	Number	No	Update time
event	String	No	Event type

Conversation Updated

This event is triggered when any attribute in the conversation is updated.

{ "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> Conversation attribute content }

              
              {
  "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> Conversation attribute content
}

Diesen Codeblock im schwebenden Fenster anzeigen

Conversation Update Event Parameters

Field	Type	Required	Description
event	String	No	Event type
changed_attributes	Array	No	Changed attributes list
field_name	Object	No	Changed field name
previous_value	String	No	Value before change
current_value	String	No	Value after change

Conversation Status Changed

This event is triggered when the conversation status changes.

{ "event": "conversation_status_changed" // <...Conversation Attributes> Conversation attribute content }

              
              {
  "event": "conversation_status_changed"
  // <...Conversation Attributes> Conversation attribute content
}

Diesen Codeblock im schwebenden Fenster anzeigen

Message Created

This event is triggered when a user or customer service sends a message.

{ "account": { "id": 17629000001207, "name": "1112" }, "additional_attributes": {}, "content_attributes": {}, "content_type": "text", "content": "Hello, what can I help you with?", "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": "Hello, what can I help you with?", "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": "Hello, what can I help you with?", "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": "Hello, what can I help you with?",
  "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": "Hello, what can I help you with?",
        "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": "Hello, what can I help you with?",
        "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"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Message Creation Event Parameters

Field	Type	Required	Description
account	Object	No	Account information
id	Number	No	Project ID
name	String	No	Project name
additional_attributes	Object	No	Additional attributes
content_attributes	Object	No	Content attributes
content_type	String	No	Content type
content	String	No	Message content
conversation	Object	No	Conversation information
created_at	String	No	Creation time
id	Number	No	Message ID
inbox	Object	No	Channel information
id	Number	No	Channel ID
name	String	No	Channel name
message_type	String	No	Message type
conversation_topic_id	String	No	Conversation topic ID
private	Boolean	No	Whether private
sender	Object	No	Sender information
id	Number	No	Sender ID
name	String	No	Sender name
email	String	No	Sender email
type	String	No	Sender type
availability	String	No	Sender availability status
source_id	String	No	Source ID
participants	Object	No	Participants information
event	String	No	Event type

Message Updated

This event is triggered when the message content in the conversation is updated.

{ "event": "message_updated" // <...Message Attributes> Message attribute content }

              
              {
  "event": "message_updated"
  // <...Message Attributes> Message attribute content
}

Diesen Codeblock im schwebenden Fenster anzeigen