Help Center

Help Center memungkinkan Anda memberikan akses cepat kepada pelanggan ke informasi dan biasanya digunakan untuk FAQ. Setelah diaktifkan, bagian khusus akan muncul di widget Anda, di mana pengguna dapat mencari atau menelusuri konten yang telah Anda unggah.

Cara Mengatur Help Center

Buka Settings > Web Widget, klik Edit pada widget yang ingin dikonfigurasi, lalu pindah ke tab Prechat dan buka bagian Help Center Configuration.

Terdapat dua mode editor untuk mengatur konten help center: Visual dan Advanced.

Visual Builder

Visual builder memungkinkan Anda mengelola konten help center tanpa perlu menulis JSON secara manual. Anda dapat menambah, mengedit, dan mengatur kategori serta halaman langsung dari antarmuka visual.

Fitur yang tersedia di visual builder:

Menambah kategori baru dengan tombol + di panel Categories
Menambah halaman baru dalam kategori dengan tombol New Page
Mengatur visibilitas halaman dengan toggle Visible
Mengedit atau menghapus kategori dan halaman melalui menu ⋯
Mengatur urutan kategori dan halaman dengan drag and drop

Advanced (JSON Editor)

Mode Advanced menampilkan text editor JSON bawaan untuk mengelola konten help center secara langsung. Mode ini cocok untuk konfigurasi yang lebih kompleks atau untuk pengguna yang sudah familiar dengan format JSON.

Terdapat beberapa cara untuk bekerja dengan JSON editor:

Download Template: klik tombol Download Template untuk mendapatkan template dokumen dengan format yang benar
Import: setelah mengedit template, impor kembali ke sistem. Hanya file berformat .json yang didukung
Edit langsung: edit konten langsung di text editor bawaan untuk perubahan cepat

Help Center Schema

Help center schema menyediakan pendekatan terstruktur untuk mengorganisasi konten menggunakan JSON schema. Schema ini memungkinkan konten diorganisasi ke dalam kategori dan halaman, dengan dukungan untuk berbagai elemen interaktif.

Struktur Schema

Help center schema menggunakan struktur hierarki:

Objek root berisi versi schema dan daftar kategori
Setiap kategori berisi informasi kategori dan daftar halaman
Setiap halaman berisi informasi halaman dengan konten yang diorganisasi ke dalam bagian body dan footer
Bagian konten berisi berbagai jenis elemen (markdown, button, link, dll.)

Schema Version

{
  "schema_version": "1",
  "categories": [...]
}

Selalu sertakan field schema_version di level root. Saat ini, "1" adalah satu-satunya versi yang didukung.

Field	Type	Deskripsi	Wajib	Keterangan
schema_version	string	Versi dari schema	Ya	Harus "1" (saat ini belum ada versi lain)
categories	array	Daftar kategori help center	Ya	Maksimal 200 kategori

Field	Type	Deskripsi	Wajib	Keterangan
title	string	Nama tampilan untuk kategori	Ya	Maks. 100 karakter
key	string	Identifier unik untuk kategori (alfanumerik & tanda hubung saja)	Ya	Maks. 100 karakter, hanya alfabet dan numerik, gunakan - sebagai spasi
description	string	Deskripsi singkat kategori	Ya	Maks. 255 karakter
pages	array	Daftar halaman help dalam kategori ini	Ya	Maksimal 500 halaman

Pages

Pages adalah artikel atau konten bantuan individual dalam sebuah kategori.

"pages": [
  {
    "key": "how-to-reset-password",
    "include_on_root": true,
    "title": "How to Reset Your Password",
    "description": "Learn how to securely reset your password if you've forgotten it.",
    "body": "",
    "footer": ""
  }
]

Field	Type	Deskripsi	Wajib	Keterangan
key	string	Identifier unik untuk halaman (alfanumerik & tanda hubung saja)	Ya	Maks. 100 karakter, hanya alfabet dan numerik, gunakan - sebagai spasi
include_on_root	boolean	Apakah menampilkan halaman ini di halaman utama help center	Tidak	Default false jika tidak disertakan
title	string	Nama tampilan untuk halaman	Ya	Maks. 100 karakter
description	string	Deskripsi singkat halaman	Ya	Maks. 255 karakter
body	object	Kontainer untuk elemen konten utama	Ya
footer	object	Kontainer untuk elemen footer (opsional)	Tidak

Content Sections

Baik objek body maupun footer berisi array elements dengan komponen konten.

"body": {
  "elements": [...]
}

"footer": {
  "elements": [...]
}

Field	Type	Deskripsi	Wajib	Keterangan
elements	object	Elemen-elemen pada body atau footer halaman	Tidak	Maksimal 500 elemen

Element Types

Markdown

Untuk konten teks dengan dukungan formatting.

{
  "type": "MARKDOWN",
  "content": "If you've forgotten your password, follow these steps to reset it: \n\n1. Go to the login page. \n2. Click on 'Forgot Password?'. \n3. Enter your registered email address..."
}

Field	Type	Deskripsi	Wajib	Keterangan
type	string	Harus "MARKDOWN"	Ya
content	string	Konten teks berformat Markdown	Ya	Maks. 10.000 karakter

Help Center Page Link

Untuk menautkan ke halaman lain di dalam help center.

{
  "type": "HELP_CENTER_PAGE_LINK",
  "page_key": "how-to-delete-account"
}

Field	Type	Deskripsi	Wajib
type	string	Harus "HELP_CENTER_PAGE_LINK"	Ya
page_key	string	Key dari halaman yang ditautkan	Ya

Iframe

Untuk menyematkan halaman website Anda sendiri.

{
  "type": "IFRAME",
  "url": "https://youriframeurl.com/path",
  "propagate_data": false,
  "height": "600px"
}

Field	Type	Deskripsi	Wajib	Keterangan
type	string	Harus "IFRAME"	Ya
url	string	URL src dari Iframe Anda	Ya	Maks. 1000 karakter
propagate_data	bool	Mengizinkan pengiriman data ke iframe via query param	Tidak	Lihat catatan di dokumen
height	string	Tinggi iframe	Tidak
sandbox	string	Sama dengan atribut sandbox HTML	Tidak	Maks. 200 karakter

Button

Elemen interaktif untuk aksi.

Field	Type	Deskripsi	Wajib
type	string	Harus "BUTTON"	Ya
action	string	Jenis aksi (saat ini hanya "START_CONVERSATION")	Ya
label	object	Berisi label yang ditampilkan pada button	Ya
metadata	object	Data spesifik aksi	Tidak*

*persyaratan metadata dapat berbeda untuk setiap aksi yang berbeda

Label Metadata

Field	Type	Deskripsi	Wajib	Keterangan
text	string	Teks pada button	Ya	Maks. 100 karakter

START_CONVERSATION Metadata

Field	Type	Deskripsi	Wajib	Keterangan
topic_keys	array of string	Topic key untuk form prechat	Tidak	Maksimal 20 key

Contoh Schema Lengkap

Berikut adalah contoh minimal yang menunjukkan struktur dasar:

{
  "schema_version": "1",
  "categories": [
    {
      "type": "HELP_CENTER_CATEGORY",
      "title": "Category Title",
      "key": "category-key",
      "description": "Category description",
      "pages": [
        {
          "type": "HELP_CENTER_PAGE",
          "key": "page-key",
          "include_on_root": true,
          "title": "Page Title",
          "description": "Page description",
          "body": {
            "elements": [
              {
                "type": "MARKDOWN",
                "content": "Markdown content goes here"
              }
            ]
          }
        }
      ]
    }
  ]
}

Aturan Validasi

Semua key (kategori dan halaman) harus unik
Semua referensi page_key harus menunjuk ke halaman yang ada
Semua field wajib harus disertakan

Contoh Sederhana

Anda dapat menggunakan contoh sederhana ini untuk keperluan pengujian, namun harap ubah topic_keys menjadi topic key yang benar dan ada di workspace Anda.

{
  "schema_version": "1",
  "categories": [
    {
      "title": "Account Management",
      "key": "account-management",
      "description": "How to manage your account",
      "pages": [
        {
          "key": "how-to-reset-password",
          "include_on_root": true,
          "title": "How to Reset Your Password",
          "description": "Learn how to securely reset your password if you've forgotten it.",
          "body": {
            "elements": [
              {
                "type": "MARKDOWN",
                "content": "If you've forgotten your password, follow these steps to reset it: \n\n1. Go to the login page. \n2. Click on 'Forgot Password?'. \n3. Enter your registered email address. \n4. Check your email for the reset link. \n5. Follow the instructions to set a new password."
              },
              {
                "type": "MARKDOWN",
                "content": "Need to delete your account instead? Learn more here:"
              },
              {
                "type": "HELP_CENTER_PAGE_LINK",
                "page_key": "how-to-delete-account"
              }
            ]
          },
          "footer": {
            "elements": [
              {
                "type": "BUTTON",
                "action": "START_CONVERSATION",
                "label": {
                  "text": "Chat with Us for Details"
                },
                "metadata": {
                  "topic_keys": ["<YOUR TOPIC KEY>"]
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

Help Center

On this page