logoDocumentación
Buscar

Webhook Events

Conversación Creada

Cuando un usuario crea exitosamente una nueva conversación mediante la API, la dirección webhook configurada para el canal API recibirá un evento de devolución de llamada de creación de conversación.

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

            
Este bloque de código se muestra en una ventana flotante

Parámetros del Evento de Creación de Conversación

Campo Tipo Requerido Descripción
account Objeto No Información del proyecto de la cuenta
id Número No ID del proyecto
name Cadena No Nombre del proyecto
additional_attributes Objeto No Atributos adicionales
can_reply Booleano No Si es posible responder
channel Cadena No Tipo de canal, como api, email, etc.
contact_inbox Objeto No Información de contacto
id Número No ID de la tabla contact_inbox, registra la relación entre contacto y canal
contact_id Número No ID de contacto
inbox_id Número No ID del canal
source_id Cadena No ID de origen de la conversación, como el user_id de Telegram
created_at Cadena No Fecha/hora de creación
updated_at Cadena No Fecha/hora de actualización
hmac_verified Booleano No Estado de verificación HMAC
pubsub_token Cadena No Token de publicación-suscripción
id Número No ID de la conversación
inbox_id Número No ID del canal
messages Arreglo No Lista de mensajes
labels Arreglo No Lista de etiquetas
meta Objeto No Información meta
sender Objeto No Información del remitente
additional_attributes Objeto No Atributos adicionales del remitente
custom_attributes Objeto No Atributos personalizados del remitente
email Cadena No Correo electrónico del remitente
id Número No ID interno del remitente en liveDesk
identifier Cadena No Identificador del remitente
name Cadena No Nombre del remitente
phone_number Cadena No Número telefónico del remitente
thumbnail Cadena No Avatar del remitente
blocked Booleano No Si el remitente está bloqueado
type Cadena No Tipo de remitente
assignee Objeto No Información del agente asignado
team Objeto No Información del equipo asignado
hmac_verified Booleano No Estado de verificación HMAC
channel Cadena No Tipo de canal
status Cadena No Estado de la conversación, como open, closed, etc.
custom_attributes Objeto No Atributos personalizados
snoozed_until Cadena No Posponer hasta cierta hora
unread_count Número No Conteo de mensajes no leídos
first_reply_created_at Cadena No Hora de la primera respuesta
priority Cadena No Prioridad
waiting_since Número No Hora de inicio de espera
conversation_category Cadena No Categoría de la conversación
chat_mode Cadena No Modo de chat
ticket_info Objeto No Información del ticket
agent_last_seen_at Número No Hora de última vista del agente
contact_last_seen_at Número No Hora de última vista del contacto
last_activity_at Número No Hora de última actividad
timestamp Número No Marca de tiempo
created_at Número No Hora de creación
updated_at Número No Hora de actualización
event Cadena No Tipo de evento

Conversación Actualizada

Este evento se desencadena cuando se actualiza cualquier atributo de la conversación.

{ "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> Contenido de los atributos de la conversación }
              
              {
  "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> Contenido de los atributos de la conversación
}

            
Este bloque de código se muestra en una ventana flotante

Parámetros del Evento de Actualización de Conversación

Campo Tipo Requerido Descripción
event Cadena No Tipo de evento
changed_attributes Arreglo No Lista de atributos cambiados
field_name Objeto No Campo que ha cambiado
previous_value Cadena No Valor antes del cambio
current_value Cadena No Valor después del cambio

Cambio de Estado de Conversación

Este evento se desencadena cuando cambia el estado de la conversación.

{ "event": "conversation_status_changed" // <...Conversation Attributes> Contenido de los atributos de la conversación }
              
              {
  "event": "conversation_status_changed"
  // <...Conversation Attributes> Contenido de los atributos de la conversación
}

            
Este bloque de código se muestra en una ventana flotante

Mensaje Creado

Este evento se desencadena cuando un usuario o un agente envía un mensaje.

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

            
Este bloque de código se muestra en una ventana flotante

Parámetros del Evento de Creación de Mensaje

Campo Tipo Requerido Descripción
account Objeto No Información de la cuenta
id Número No ID del proyecto
name Cadena No Nombre del proyecto
additional_attributes Objeto No Atributos adicionales
content_attributes Objeto No Atributos del contenido
content_type Cadena No Tipo de contenido
content Cadena No Contenido del mensaje
conversation Objeto No Información de la conversación
created_at Cadena No Hora de creación
id Número No ID del mensaje
inbox Objeto No Información del canal
id Número No ID del canal
name Cadena No Nombre del canal
message_type Cadena No Tipo de mensaje
conversation_topic_id Cadena No ID del tema de conversación
private Booleano No Si es privado
sender Objeto No Información del remitente
id Número No ID del remitente
name Cadena No Nombre del remitente
email Cadena No Correo del remitente
type Cadena No Tipo del remitente
availability Cadena No Estado de disponibilidad del remitente
source_id Cadena No ID de la fuente
participants Objeto No Información de los participantes
event Cadena No Tipo de evento

Mensaje Actualizado

Este evento se desencadena cuando se actualiza el contenido de un mensaje en la conversación.

{ "event": "message_updated" // <...Message Attributes> Contenido de los atributos del mensaje }
              
              {
  "event": "message_updated"
  // <...Message Attributes> Contenido de los atributos del mensaje
}

            
Este bloque de código se muestra en una ventana flotante
icon
Contacto