Plugin Setup

Buka di CMS

Langkah pertama adalah membuat konfigurasi plugin Reminder untuk agent Anda. Konfigurasi ini menyimpan kredensial, akun messaging, dan pengaturan perilaku yang dipakai oleh semua reminder item di bawah instance ini.

Buka Tools → Plugins di sidebar agent, klik Create New Plugin, lalu pilih Reminder.


Field Konfigurasi

FieldDeskripsi
NameLabel untuk instance plugin ini. Dipakai untuk mengenalinya di panel admin.
Notification KeyAPI key dari CMS yang mengotorisasi plugin untuk mengirim template notifikasi atas nama agent Anda.
Account CodeAkun messaging (misalnya WhatsApp) yang dipakai untuk mengirim reminder.
Default ToneGaya bahasa yang dipakai AI saat menyusun isi reminder. Default-nya polite.
Webhook URLOpsional. URL eksternal yang menerima HTTP POST setelah setiap pengiriman reminder. Lihat Webhook Notifications.

Kredensial yang Dibuat Otomatis

Saat konfigurasi disimpan, tiga kredensial dibuat secara otomatis:

KredensialKegunaan
SecretDipakai oleh layanan Dialog untuk mengautentikasi pembuatan reminder oleh AI.
Primary KeyDipakai oleh sistem eksternal untuk mengautentikasi panggilan Integration API.
Secondary KeyKey cadangan untuk Integration API. Berguna untuk rotasi key tanpa downtime.

Simpan kredensial ini dengan aman. Kredensial ditampilkan sekali saat dibuat dan dapat dibuat ulang nanti, tetapi membuat ulang sebuah key akan membatalkan semua pemanggil yang masih memakainya.


Memperbarui Integration Key

Jika sebuah key bocor atau Anda perlu merotasi kredensial, Anda dapat memperbarui setiap key secara terpisah.

Perbarui kedua key sekaligus:

POST /api/reminder/configuration/{agentId}/{configurationId}/refresh-keys

Perbarui satu key saja:

POST /api/reminder/configuration/{agentId}/{configurationId}/refresh-keys?keyType=primary
POST /api/reminder/configuration/{agentId}/{configurationId}/refresh-keys?keyType=secondary

Response berisi nilai key yang baru. Semua pemanggil Integration API yang masih memakai key lama harus segera diperbarui setelah refresh.


Memperbarui Notification Key

Jika notification key CMS Anda berubah, perbarui tanpa perlu membuat ulang seluruh konfigurasi:

PUT /api/reminder/configuration/notification-key

Request body:

FieldDeskripsi
notificationKeyNotification key baru dari CMS.
accountCodeOpsional. Perbarui kode akun messaging sekaligus.

Membuat Nama Function dengan AI

Fitur Generate Function Name memakai AI untuk menyarankan identifier function berdasarkan deskripsi tujuan plugin Anda. Nama ini dipakai saat plugin disediakan untuk AI sebagai tool yang bisa dipanggil.

POST /api/reminder/configuration/generate-function-name

Request body:

{
  "description": "Schedule appointment reminders for clinic patients"
}

Response:

{
  "functionName": "schedule_appointment_reminder"
}

Gunakan nama ini di pengaturan function tool AI Anda. Lihat AI Function Tool.


Server State

Setiap konfigurasi memiliki Server State yang mengatur apakah pengiriman reminder aktif. Nilainya running atau paused.

  • Selama paused, processor latar belakang melewati semua reminder milik konfigurasi ini.
  • Selama running, reminder yang tertunda dikirim sesuai jadwal.

Untuk mengubah state:

PUT /api/reminder/configuration/{agentId}/{configurationId}/server-state

Request body:

{
  "serverState": "paused"
}

Setiap perubahan state dicatat di audit log beserta timestamp dan identitas user yang melakukan perubahan. Sepuluh perubahan state terakhir disimpan.


Halaman Terkait