Logo Site EngageLab Mark Colored TransparentDokumen
LiveDesk
Beranda Dokumen
Pengenalan ProdukAkses CepatPanduan KonsolREST API
Cari
Masuk
Panduan Konsol/Saluran/API/Peristiwa Callback Webhook
Panduan KonsolSaluranAPIPeristiwa Callback Webhook...

Peristiwa Callback Webhook

Terakhir diperbarui：5 bulan yang lalu

Percakapan Dibuat

Saat pengguna berhasil membuat percakapan baru dengan memanggil API, alamat webhook yang dikonfigurasi untuk channel API akan menerima peristiwa callback pembuatan percakapan.

{ "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"
}
Tampilkan blok kode ini di jendela mengambang

Parameter Peristiwa Pembuatan Percakapan

Field Type Required Description
account Object No Informasi akun/proyek
id Number No ID proyek
name String No Nama proyek
additional_attributes Object No Atribut tambahan
can_reply Boolean No Menunjukkan apakah balasan dimungkinkan
channel String No Tipe channel, misalnya API, email, dan sebagainya
contact_inbox Object No Informasi kontak
id Number No ID tabel contact_inbox, yang mencatat relasi antara kontak dan channel
contact_id Number No ID kontak
inbox_id Number No ID channel
source_id String No ID sumber percakapan, misalnya user_id Telegram
created_at String No Waktu pembuatan
updated_at String No Waktu pembaruan
hmac_verified Boolean No Status verifikasi HMAC
pubsub_token String No Token publish-subscribe
id Number No ID percakapan
inbox_id Number No ID channel
messages Array No Daftar pesan
labels Array No Daftar label
meta Object No Informasi meta
sender Object No Informasi pengirim
additional_attributes Object No Atribut tambahan pengirim
custom_attributes Object No Atribut kustom pengirim
email String No Email pengirim
id Number No ID internal pengirim di liveDesk
identifier String No Pengidentifikasi pengirim
name String No Nama pengirim
phone_number String No Nomor telepon pengirim
thumbnail String No Avatar pengirim
blocked Boolean No Menunjukkan apakah pengirim diblokir
type String No Tipe pengirim
assignee Object No Informasi agen layanan pelanggan yang ditugaskan
team Object No Informasi tim layanan pelanggan yang ditugaskan
hmac_verified Boolean No Status verifikasi HMAC
channel String No Tipe channel
status String No Status percakapan, misalnya open, closed, dan sebagainya
custom_attributes Object No Atribut kustom
snoozed_until String No Ditunda hingga waktu tertentu
unread_count Number No Jumlah pesan yang belum dibaca
first_reply_created_at String No Waktu pembuatan balasan pertama
priority String No Prioritas
waiting_since Number No Waktu mulai menunggu
conversation_category String No Kategori percakapan
chat_mode String No Mode chat
ticket_info Object No Informasi tiket
agent_last_seen_at Number No Waktu terakhir agen terlihat
contact_last_seen_at Number No Waktu terakhir kontak terlihat
last_activity_at Number No Waktu aktivitas terakhir
timestamp Number No Stempel waktu
created_at Number No Waktu pembuatan
updated_at Number No Waktu pembaruan
event String No Tipe peristiwa

Percakapan Diperbarui

Peristiwa ini dipicu saat atribut apa pun dalam percakapan diperbarui.

{ "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> Konten atribut percakapan }
              
              {
  "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> Konten atribut percakapan
}
Tampilkan blok kode ini di jendela mengambang

Parameter Peristiwa Pembaruan Percakapan

Field Type Required Description
event String No Tipe peristiwa
changed_attributes Array No Daftar atribut yang berubah
field_name Object No Nama field yang berubah
previous_value String No Nilai sebelum perubahan
current_value String No Nilai setelah perubahan

Status Percakapan Berubah

Peristiwa ini dipicu saat status percakapan berubah.

{ "event": "conversation_status_changed" // <...Conversation Attributes> Konten atribut percakapan }
              
              {
  "event": "conversation_status_changed"
  // <...Conversation Attributes> Konten atribut percakapan
}
Tampilkan blok kode ini di jendela mengambang

Pesan Dibuat

Peristiwa ini dipicu saat pengguna atau agen layanan pelanggan mengirim pesan.

{ "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"
}
Tampilkan blok kode ini di jendela mengambang

Parameter Peristiwa Pembuatan Pesan

Field Type Required Description
account Object No Informasi akun
id Number No ID proyek
name String No Nama proyek
additional_attributes Object No Atribut tambahan
content_attributes Object No Atribut konten
content_type String No Tipe konten
content String No Konten pesan
conversation Object No Informasi percakapan
created_at String No Waktu pembuatan
id Number No ID pesan
inbox Object No Informasi channel
id Number No ID channel
name String No Nama channel
message_type String No Tipe pesan
conversation_topic_id String No ID topik percakapan
private Boolean No Menunjukkan apakah pesan bersifat privat
sender Object No Informasi pengirim
id Number No ID pengirim
name String No Nama pengirim
email String No Email pengirim
type String No Tipe pengirim
availability String No Status ketersediaan pengirim
source_id String No ID sumber
participants Object No Informasi peserta
event String No Tipe peristiwa

Pesan Diperbarui

Peristiwa ini dipicu saat konten pesan dalam percakapan diperbarui.

{ "event": "message_updated" // <...Message Attributes> Konten atribut pesan }
              
              {
  "event": "message_updated"
  // <...Message Attributes> Konten atribut pesan
}
Tampilkan blok kode ini di jendela mengambang
Icon Solid Transparent White Qiyu
Hubungi Sales