Tambah webhook

Daftarkan URL HTTPS sistem Anda dan event yang ingin diterima.

Maksimal 5 webhook per bisnis. Jawaban memuat secret sekali saja (bisa dilihat lagi di Pengaturan › API & Webhook). Pakai secret itu untuk memeriksa header Klikflow-Signature.

Kirim header Idempotency-Key (misalnya UUID baru per permintaan). Ulangan dengan kunci yang sama dalam 24 jam mendapat jawaban pertama lagi, jadi tidak terkirim dua kali.

Kunci: kf_live_ / kf_test_… di header Authorization: Bearer. Dibuat di Pengaturan › API & Webhook › Buat kunci.
Izin kunci: webhooks:manage
Fitur paket: API kirim WhatsApp

Body (JSON)

urlstringwajib
URL HTTPS publik, maksimal 500 karakter.
eventsarray: message.received | message.status | contact.created | lead.created | order.paid | ticket.created | ticket.status | template.status | channel.statuswajib
Event yang dikirim, lihat panduan Event webhook.
descriptionstring
Keterangan, maksimal 120 karakter.

Error yang mungkin

400 invalid_json Body bukan JSON yang sah
400 idempotency_key_invalid Idempotency-Key tidak sah
401 missing_key Kunci API belum dikirim
401 key_invalid Kunci API tidak dikenal
401 key_revoked Kunci API sudah dicabut
401 key_expired Kunci API kedaluwarsa
401 member_inactive Pembuat kunci bukan anggota lagi
403 ip_not_allowed IP server tidak ada di daftar kunci
403 plan_no_api Paket belum memuat API untuk kunci live
403 tenant_blocked Akses bisnis ditangguhkan
403 scope_missing Kunci tidak punya izin ini
403 permission_missing Role pembuat kunci tidak punya izin ini
403 live_key_required Butuh kunci live
409 idempotency_conflict Idempotency-Key dipakai untuk isi lain
409 request_in_progress Permintaan yang sama masih diproses
422 invalid_request Field tidak sah
422 webhook_limit Batas jumlah webhook tercapai
429 rate_limited Terlalu banyak permintaan per menit
500 internal_error Gangguan di Klik Flow

Coba

Endpoint ini butuh kunci live, jadi tidak bisa dicoba di halaman docs. Panggil dari server Anda.

Contoh permintaan

curl -X POST "https://klikflow.id/api/v2/webhooks" \
  -H "Authorization: Bearer KUNCI_API" \
  -H "Idempotency-Key: 6f1c2a8e-4b1d-4c3a-9e2f-1a2b3c4d5e6f" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://toko-anda.id/klikflow/webhook","events":["message.received","message.status","order.paid"],"description":"Server toko"}'

Contoh jawaban 201

{
  "data": {
    "id": 6,
    "object": "webhook",
    "url": "https://toko-anda.id/klikflow/webhook",
    "description": "Server toko",
    "events": [
      "message.received",
      "message.status",
      "order.paid"
    ],
    "status": "active",
    "paused_reason": null,
    "health": "Belum ada kiriman 7 hari",
    "failed_count": 0,
    "created_at": "2026-11-01T02:00:00.000Z",
    "last_success_at": null,
    "last_failure_at": null,
    "secret": "whsec_4Hf2Kp9Lq7Rt1Zs8Vb3Nm6Xc0Ya5Wd2E"
  }
}

Body (JSON)

Error yang mungkin

Coba

Kirim WhatsApp dari sistem Anda lewat API Klik Flow.