Webhook Notifications

Buka di CMS

Plugin Reminder dapat mengirim HTTP POST ke URL pilihan Anda setelah setiap percobaan pengiriman reminder. Gunakan webhook untuk menjaga sistem eksternal (seperti CRM, helpdesk, atau dashboard kustom) tetap sinkron dengan perubahan status reminder secara real-time.


Mengonfigurasi Webhook URL

Atur webhook URL saat membuat atau memperbarui konfigurasi plugin:

POST /api/reminder/configuration
PUT  /api/reminder/configuration

Sertakan field integrationSettings di request body:

{
  "integrationSettings": {
    "webhookUrl": "https://your-system.com/api/reminder-webhook"
  }
}

Webhook URL disimpan bersama konfigurasi dan dipakai untuk semua reminder item di bawah konfigurasi tersebut. Untuk menonaktifkan webhook, isi URL dengan string kosong atau hilangkan field-nya.


Payload Webhook

Saat sebuah percobaan pengiriman selesai, berhasil maupun tidak, plugin mengirim HTTP POST ke URL yang dikonfigurasi dengan body JSON berikut:

FieldTipeDeskripsi
idstringIdentifier unik reminder item.
datedatetimeTimestamp UTC percobaan pengiriman.
statusstringStatus reminder saat ini: active, completed, expired, atau cancelled.
detailstringDeskripsi aksi yang mudah dibaca, misalnya Reminder sent atau Send failed.

Contoh payload:

{
  "id": "rem-abc123",
  "date": "2025-06-01T02:00:00Z",
  "status": "completed",
  "detail": "Reminder sent"
}

Kapan Webhook Dipanggil

Webhook dikirim setelah setiap percobaan pengiriman. Kejadian pemicunya adalah:

KejadianNilai statusNilai detail
Reminder berhasil dikirimactive atau completedReminder sent
Percobaan pengiriman gagalactiveSend failed
Reminder maju ke waktu kirim berikutnya setelah retry maksimumactiveBervariasi
Semua waktu kirim habis setelah pengiriman terakhircompletedReminder sent

Jika tidak ada lagi waktu kirim setelah pengiriman berhasil, status di payload akan bernilai completed.


Perilaku Pengiriman

  • Webhook dikirim sebagai request HTTP POST fire-and-forget.
  • Jika endpoint Anda mengembalikan error atau tidak dapat dijangkau, kegagalan dicatat di log tetapi tidak memengaruhi pemrosesan reminder maupun logika retry.
  • Tidak ada retry otomatis untuk pengiriman webhook yang gagal.
  • Endpoint Anda harus merespons dalam batas waktu yang wajar untuk menghindari error koneksi di sisi plugin.

Mengamankan Endpoint Webhook Anda

Plugin tidak menandatangani payload webhook. Untuk melindungi endpoint Anda dari panggilan yang tidak sah:

  1. Gunakan path yang sulit ditebak, misalnya sertakan token acak di URL: https://your-system.com/hooks/reminder/a3f9b2c1d4.
  2. Cocokkan field id dengan data Anda sendiri sebelum memproses kejadian.
  3. Batasi endpoint Anda hanya untuk rentang IP host plugin yang dikenal.

Halaman Terkait