Event

Beri tahu Beamvia saat sesuatu terjadi di sistem Anda (pesanan selesai, pembayaran gagal, paket dikirim). Event masuk ke percakapan terbaru kontak dan Beamvia bereaksi sesuai pilihan Anda.

reaction	Yang terjadi
AI	AI agent aktif sekali, membaca event, lalu memberi tahu pelanggan hal yang penting. Beralih ke TEAM jika percakapan ditangani orang atau AI tidak tersedia.
TEAM	Hanya catatan privat di inbox untuk tim Anda. Tidak ada yang dikirim ke pelanggan.
MESSAGE	Langsung mengirim template Anda ke pelanggan, tanpa biaya AI.

Data event ditampilkan ke AI sebagai data eksternal: HTML dihapus, teks panjang dipotong, dan instruksi di dalamnya tidak pernah diikuti. Event tidak bisa mengonfirmasi aksi berisiko tinggi atas nama pelanggan.

Kirim event

Membutuhkan scope event:write. Mengembalikan 202; delivered bernilai false dengan reason jika reaksi tidak sampai ke pelanggan.

Scopeevent:write

toobjectrequired

Kontak terkait event: { "type": "WHATSAPP", "phone" }, { "type": "EMAIL", "address" }, { "type": "TELEGRAM", "userId" } atau { "contactId" }.

typestringrequired

Nama event, huruf kecil, angka, _ . - (maks 60), mis. order.completed.

dataobject

Objek JSON apa pun, maksimal 8 KB.

reactionstring

AI (bawaan), TEAM atau MESSAGE.

instructionstring

Petunjuk untuk AI, mis. "Bagikan nomor resi". Maks 500 karakter.

templatestring

Wajib untuk MESSAGE. Mendukung <%= contact.name.first %> dan <%= event.field %>.

channelIdstring

Gunakan percakapan di channel ini; memulai percakapan WhatsApp jika belum ada.

idstring

Kunci idempotensi. Mengirim id yang sama lagi mengembalikan event pertama, bukan event baru.

POSThttps://www.beamvia.com/api/v1/event

curl -X POST "https://www.beamvia.com/api/v1/event" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "order-1042-completed",
    "to": {
      "type": "WHATSAPP",
      "phone": "+6281234567890"
    },
    "type": "order.completed",
    "data": {
      "order": {
        "number": "1042",
        "total": "Rp 250.000",
        "tracking": "JNE123456"
      }
    },
    "instruction": "Tell the customer the order is complete and share the tracking number"
  }'

{
  "status": true,
  "message": "Event received",
  "data": {
    "event": {
      "id": "6650f0c2a1b2c3d4e5f60720"
    },
    "conversationId": "6650f0c2a1b2c3d4e5f60700",
    "delivered": true,
    "reason": null
  }
}