Dokumentasi

Properti Kontak

Tetapkan field khusus untuk kontak — seperti tipe akun, wilayah, atau tingkat kontrak — dan teruskan melalui widget. Properti ditampilkan di profil kontak, dapat diedit oleh agen, dan dapat difilter di Inbox.

Ikhtisar#

Properti Kontak memungkinkan Anda melampirkan data terstruktur ke percakapan di luar field bawaan (email, name, userId). Berbeda dengan metadata berbentuk bebas, properti memiliki skema yang terdefinisi dengan tipe, label, dan validasi — mirip dengan field khusus di HubSpot atau Salesforce.

Tetapkan Skema

Buat definisi properti di Pengaturan Agen dengan tipe seperti string, number, enum, boolean, date, url

Teruskan dari Widget

Kirim nilai properti melalui Respondo.identify() — nilai tersebut disimpan dan ditampilkan secara otomatis

Filter & Edit

Filter percakapan berdasarkan nilai properti di Inbox. Agen dapat melihat dan mengedit atribut kontak di profil kontak.

Mendefinisikan Properti#

Properti didefinisikan per agen di Pengaturan Agen → Properti Kontak. Setiap properti memiliki:

FieldDeskripsi
keyPengenal unik yang digunakan dalam kode. Dihasilkan otomatis dari label (dapat diedit). Huruf kecil, angka, dan garis bawah; harus diawali huruf; 2-63 karakter. Key sistem (user_id, visitor_id, timezone, page_url, …) dicadangkan. Contoh: account_type
labelNama yang mudah dibaca yang ditampilkan di dashboard. Contoh: "Account Type"
typeTipe nilai: string, number, boolean, enum, date, url
enum_valuesUntuk tipe enum — daftar nilai yang diizinkan. Contoh: ["starter", "pro", "enterprise"]
is_filterableDicadangkan untuk kontrol filter di masa depan; disimpan bersama definisi, tetapi pemilih filter Inbox saat ini menampilkan semua properti yang didefinisikan (default: true)
is_visibleDicadangkan untuk kontrol tampilan di masa depan; disimpan bersama definisi tetapi belum diberlakukan di UI (default: true)
Hingga 50 properti per agen. Properti dapat diurutkan ulang dengan tarik-dan-lepas di UI pengaturan.

Meneruskan dari Widget#

Teruskan nilai properti pada field properties dari Respondo.identify(). Key harus cocok dengan definisi properti dari Pengaturan Agen.

Integrasi widgetjavascript
Respondo.identify({
  email: 'user@example.com',
  name: 'Jane Smith',
  userId: 'usr_456',
  properties: {
    account_type: 'enterprise',   // enum
    region: 'eu-west',            // string
    monthly_spend: '15000',       // number (diteruskan sebagai string)
    is_partner: 'true',           // boolean (diteruskan sebagai string)
    contract_end: '2026-12-31',   // date
    dashboard_url: 'https://app.example.com/org/123'  // url
  }
});
Semua nilai properti diteruskan sebagai string. Dashboard menangani tampilan spesifik-tipe (misalnya, boolean → Ya/Tidak, url → tautan yang dapat diklik, enum → badge).

Cuplikan Integrasi#

Cuplikan Integrasi muncul secara otomatis di Pengaturan Agen → Properti Kontak begitu Anda mendefinisikan setidaknya satu properti, dengan semua key properti Anda terisi otomatis. Klik Copy untuk mengambilnya dan tempel ke dalam aplikasi Anda. Cuplikan yang dihasilkan juga menyertakan placeholder userHash untuk verifikasi identitas (HMAC-SHA256).

Bagaimana Nilai Disimpan#

Nilai properti disimpan di field JSONB metadata percakapan dengan awalan cp_. Sebagai contoh, properti dengan key account_type disimpan sebagai cp_account_type.

Properti diperbarui pada setiap pesan — jika widget mengirim nilai baru, nilai tersebut menimpa nilai yang ada. Ini berarti nilai properti selalu mencerminkan data terbaru dari aplikasi Anda.

Memfilter di Inbox#

Filter percakapan berdasarkan nilai properti menggunakan bilah filter Inbox atau Tampilan tersimpan. Tambahkan kondisi Property, pilih properti berdasarkan nama — pemilih menampilkan setiap definisi di seluruh agen Anda dan juga menerima key mentah yang tidak memiliki definisi — lalu pilih nilai. Field nilai menyarankan nilai yang pernah diamati dan nilai enum apa pun saat Anda mengetik.

Melalui API, endpoint daftar percakapan menerima parameter kueri cp.<key>=<value> (alias persis dari attr.<key>). Tidak ada sintaks kueri teks bebas:

GET /api/v1/conversations?cp.account_type=enterprise

Menyunting Nilai#

Nilai properti disetel oleh aplikasi Anda — melalui integrasi widget atau API — dan bersifat hanya-baca di panel detail percakapan. Panel menautkan ke profil kontak, tempat agen dapat melihat dan mengedit atribut kontak (Contacts → kontak → Attributes).

Properties vs Metadata

Fiturpropertiesmetadata
SkemaDidefinisikan di Pengaturan Agen dengan tipePasangan key-value berbentuk bebas
Dapat difilterYa, melalui bilah filter / Tampilan tersimpan (API: parameter cp.<key>)Tidak
Dapat diedit oleh agenTidak — nilai berasal dari aplikasi Anda; atribut kontak diedit di profil kontakTidak
Tampilan bertipeYa (badge, tautan, tanggal, boolean)Hanya teks biasa
Pelengkapan otomatisYa, saran nilai di field nilai filterTidak
Gunakan metadata untuk field ad-hoc yang tidak memerlukan pemfilteran atau tampilan bertipe. Gunakan properties untuk data terstruktur yang akan digunakan tim Anda secara aktif untuk segmentasi dan alur kerja.