Peristiwa webhook yang didukung di omnichannel
omnichannel menerbitkan berbagai peristiwa ke titik akhir webhook yang dikonfigurasi. Jika Anda ingin mengonfigurasi webhook, lihat panduannya di sini.
Setiap kejadian memiliki struktur muatan berdasarkan jenis model yang mereka gunakan. Bagian berikut ini menjelaskan objek utama yang kami gunakan dalam omnichannel dan atributnya.
Objek
Sebuah peristiwa dapat berisi salah satu objek berikut sebagai muatan. Berbagai jenis objek yang didukung dalam omnichannel adalah sebagai berikut.
Akun
Muatan berikut akan dikembalikan untuk sebuah akun.
{
"id": "integer",
"name": "string"
}
Kotak masuk
Muatan berikut akan dikembalikan untuk kotak masuk.
{
"id": "integer",
"name": "string"
}
Kontak
Muatan berikut ini akan dikembalikan untuk sebuah kontak.
{
"id": "integer",
"name": "string",
"avatar": "string",
"type": "contact",
"account": {
// <...Account Object>
}
}
Pengguna
Muatan berikut akan dikembalikan untuk agen/admin.
{
"id": "integer",
"name": "string",
"email": "string",
"type": "user"
}
Percakapan
Muatan berikut akan dikembalikan untuk percakapan.
{
"additional_attributes": {
"browser": {
"device_name": "string",
"browser_name": "string",
"platform_name": "string",
"browser_version": "string",
"platform_version": "string"
},
"referer": "string",
"initiated_at": {
"timestamp": "iso-datetime"
}
},
"can_reply": "boolean",
"channel": "string",
"id": "integer",
"inbox_id": "integer",
"contact_inbox": {
"id": "integer",
"contact_id": "integer",
"inbox_id": "integer",
"source_id": "string",
"created_at": "datetime",
"updated_at": "datetime",
"hmac_verified": "boolean"
},
"messages": ["Array of message objects"],
"meta": {
"sender": {
// Contact Object
},
"assignee": {
// User Object
}
},
"status": "string",
"unread_count": "integer",
"agent_last_seen_at": "unix-timestamp",
"contact_last_seen_at": "unix-timestamp",
"timestamp": "unix-timestamp",
"account_id": "integer"
}
Pesan
{
"id": "integer",
"content": "string",
"message_type": "integer",
"created_at": "unix-timestamp",
"private": "boolean",
"source_id": "string / null",
"content_type": "string",
"content_attributes": "object",
"sender": {
"type": "string - contact/user"
// User or Contact Object
},
"account": {
// Account Object
},
"conversation": {
// Conversation Object
},
"inbox": {
// Inbox Object
}
}
Contoh muatan webhook
{
"event": "event_name"
// Attributes related to the event
}
Peristiwa Webhook
Omnichannel mendukung acara webhook berikut ini. Anda dapat berlangganan ke acara-acara tersebut saat mengonfigurasi webhook di dasbor atau menggunakan API.
percakapan_dibuat
Peristiwa ini akan dipicu ketika percakapan baru dibuat di akun. Muatan untuk peristiwa tersebut adalah sebagai berikut.
{
"event": "conversation_created"
// <...Conversation Attributes>
}
percakapan_diperbarui
Peristiwa ini akan dipicu ketika ada perubahan pada salah satu atribut dalam percakapan.
{
"event": "conversation_updated",
"changed_attributes": [
{
"<attribute_name>": {
"current_value": "",
"previous_value": ""
}
}
]
// <...Conversation Attributes>
}
status_percakapan_berubah
Peristiwa ini akan dipicu ketika status percakapan diubah.
Catatan: Jika Anda menggunakan API bot agen dan bukan webhook, peristiwa ini belum didukung.
{
"event": "conversation_status_changed"
// <...Conversation Attributes>
}
message_created
Peristiwa ini akan dipicu ketika pesan dibuat dalam percakapan. Muatan untuk peristiwa tersebut adalah sebagai berikut.
{
"event": "message_created"
// <...Message Attributes>
}
pesan_diperbarui
Peristiwa ini akan dipicu ketika sebuah pesan diperbarui dalam percakapan. Muatan untuk peristiwa ini adalah sebagai berikut.
{
"event": "message_updated"
// <...Message Attributes>
}
webwidget_triggered
Peristiwa ini akan dipicu ketika pengguna akhir membuka widget obrolan langsung.
{
"id": ,
"contact": {
// <...Contact Object>
},
"inbox": {
// <...Inbox Object>
},
"account": {
// <...Account Object>
},
"current_conversation": {
// <...Conversation Object>
},
"source_id": "string",
"event": "webwidget_triggered",
"event_info": {
"initiated_at": {
"timestamp": "date-string"
},
"referer": "string",
"widget_language": "string",
"browser_language": "string",
"browser": {
"browser_name": "string",
"browser_version": "string",
"device_name": "string",
"platform_name": "string",
"platform_version": "string"
}
}
}
