Webhook

Dikemas kini

Lokasi: Tetapan > Integrasi > Webhook

Kegunaannya:

"Hantar peristiwa masuk ke pelayan anda sendiri." SyBox menghantar salinan setiap peristiwa yang dipilih ke alamat pelayan anda secara masa nyata. Peristiwa WhatsApp tiba dalam format Meta sendiri. Mesej pelanggan di Messenger, Instagram, Telegram, TikTok dan Live Chat, serta peristiwa perbualan (selesai, label, kenalan, urus niaga, kes CRM), tiba dalam format SyBox sendiri. Mesej emel dan SMS tidak dihantar.

Siapa yang boleh membukanya: pentadbir utama, dan ahli pasukan dengan kebenaran "Urus saluran". Untuk mencipta webhook atau mengaktifkan semula webhook yang dijeda, anda juga memerlukan kebenaran "Tunjukkan nombor kenalan", kerana data yang dihantar mengandungi nombor telefon sebenar pelanggan.

Peristiwa yang boleh anda pilih:

  • "Mesej masuk": pelanggan menghantar mesej.
  • "Status mesej": mesej yang anda hantar telah dihantar, diterima, dibaca atau gagal.
  • "Reaksi": pelanggan memberi reaksi pada mesej.
  • "Perbualan ditandakan selesai": perbualan telah ditandakan selesai, oleh ahli pasukan, oleh automasi, atau dengan sendirinya selepas pelanggan senyap.
  • "Label ditambah atau dibuang": label telah ditambah pada perbualan atau dibuang daripadanya.
  • "Kenalan dicipta atau dikemas kini": kenalan baharu telah dibuat, atau nama, emel atau medan kenalan telah berubah. Import kenalan tidak menghantar peristiwa ini.
  • "Urus niaga ditutup": urus niaga telah direkodkan dalam perbualan.
  • "Kes CRM dibuka atau ditutup": kes CRM telah dibuka, atau ditutup sebagai selesai, tidak selesai atau dibatalkan. Sesuatu kes tidak dimiliki oleh mana-mana nombor, jadi hanya webhook yang meliputi semua nombor akan menerimanya, bukan yang terhad kepada beberapa nombor.

Lima peristiwa terakhir tiba dalam format SyBox sendiri, bagi setiap saluran. Halaman Dokumentasi Pembangun menunjukkan contoh bagi setiap satu.

  • "Transkripsi suara" (pilihan tambahan): mesej suara ditahan seketika, sehingga kira-kira dua minit, supaya teks transkripsinya dapat dihantar bersama-sama. Ciri ini dimatikan melainkan anda menghidupkannya.

Cara menambah webhook

  1. Pergi ke Tetapan > Integrasi > Webhook.
    Settings, Webhooks: an active webhook with its last result, and the "Add webhook" button
  2. Klik "Tambah webhook".
    The new webhook window: its name and the address it calls
  3. Masukkan "Nama".
  4. Masukkan "URL destinasi". Ia mestilah "Alamat https awam yang boleh kami capai". Alamat http biasa dan alamat rangkaian peribadi atau dalaman akan ditolak.
  5. Di bawah "Peristiwa", aktifkan sekurang-kurangnya satu peristiwa. "Mesej masuk" diaktifkan secara lalai.
  6. Pilihan: aktifkan "Transkripsi suara" untuk menerima mesej suara bersama teksnya.
  7. Di bawah "Nombor", kekalkan pilihan "Semua nombor" untuk meliputi setiap nombor WhatsApp. Atau matikannya dan tandakan nombor tertentu yang anda mahukan sahaja.
  8. Klik Simpan.
  9. Tetingkap akan memaparkan "Kunci tandatangan". "Salin sekarang — ia hanya ditunjukkan sekali." Simpan maklumat ini pada pelayan anda.

Mengenai penghantaran:

  • Setiap penghantaran menggunakan format yang sama seperti webhook WhatsApp Meta sendiri.
  • Setiap penghantaran ditandatangani dengan kunci tandatangan anda, sama seperti cara Meta menandatangani webhooknya. Jika pelayan anda sudah menyemak webhook Meta, ia boleh menyemak webhook SyBox menggunakan kunci SyBox anda.
  • Jika pelayan anda tidak membalas dengan status berjaya, SyBox akan mencuba lagi beberapa kali dengan sela masa yang semakin panjang, selama kira-kira satu jam. Selepas itu, ia akan berhenti mencuba bagi peristiwa tersebut.
  • Peristiwa yang sama kadangkala boleh diterima dua kali, contohnya selepas tamat masa sambungan. Pelayan anda perlu mengendalikan data pendua dengan baik.

Cara menguji webhook

  1. Pastikan webhook dihidupkan. Jika ia dimatikan, anda akan melihat "Hidupkan webhook ini dahulu."
  2. Pada kadnya, klik "Hantar peristiwa ujian". Anda akan melihat "Peristiwa ujian sedang dihantar. Keputusannya akan dipaparkan di bawah Penghantaran."
  3. Beberapa saat kemudian senarai "Penghantaran" dibuka dan menunjukkan jawapan pelayan anda. Kad juga akan menunjukkan respons terakhir daripada pelayan anda beserta masanya. Respons berjaya (contohnya "HTTP 200") berwarna hijau. Ralat berwarna merah. "Penghantaran terakhir: tidak pernah" bermakna belum ada sebarang data yang dihantar.
    To test a webhook: "HTTP 200" marked on the screen in SyBox

Peristiwa ujian mempunyai "event": "test" dan tidak membawa data pelanggan. Anda boleh menghantar satu setiap beberapa saat; jika lebih awal, anda akan melihat "Ujian baru sahaja dihantar sebentar tadi. Cuba lagi dalam beberapa saat."

Cara melihat penghantaran

  1. Pada kad webhook, klik "Penghantaran".
  2. Senarai menunjukkan "50 penghantaran terakhir daripada 7 hari lepas.", daripada yang paling baharu. Setiap satu menunjukkan peristiwanya, bila ia dicuba, dan keadaannya:
    • "Dihantar": pelayan anda menjawab dengan berjaya.
    • "Menunggu untuk dihantar": ia belum dicuba lagi.
    • "Gagal, mencuba semula": pelayan anda tidak menjawab dengan berjaya, dan SyBox akan mencuba lagi kemudian.
    • "Tidak dihantar": SyBox berhenti mencuba.
    • Ia juga menunjukkan kod HTTP yang dijawab oleh pelayan anda, berapa lama jawapan diambil dalam milisaat, dan "Percubaan: [nombor]" apabila ia dicuba lebih daripada sekali. Mesej itu sendiri tidak ditunjukkan.
  3. Untuk menghantar semula, klik "Hantar semula" pada penghantaran yang berstatus "Dihantar" atau "Tidak dihantar". Anda akan melihat "Dalam giliran untuk dihantar semula." Menghantar semula memerlukan kebenaran "Tunjukkan nombor kenalan", kerana ia menghantar semula data pelanggan.

Dimatikan dengan sendirinya:

Jika pelayan anda terus gagal — 20 percubaan berturut-turut, selama lebih daripada satu jam — SyBox akan mematikan webhook tersebut. Kad menunjukkan dalam warna merah "Dimatikan dengan sendirinya selepas [nombor] penghantaran gagal berturut-turut", dan admin utama mendapat pemberitahuan, "Satu webhook telah dimatikan". Peristiwa yang menunggu disimpan selama 24 jam. Baiki alamat atau pelayan anda, kemudian hidupkan semula webhook: peristiwa yang menunggu akan dihantar, dan kiraan bermula semula daripada sifar.

Cara mengedit, menjeda atau memadam webhook

  1. Klik Edit untuk menukar nama, alamat, peristiwa atau nombor.
    To edit, pause or delete a webhook: "Edit" marked on the screen in SyBox
  2. Untuk menukar kunci tandatangan, taip kunci baharu dalam ruangan "Kunci tandatangan". Biarkan kosong jika ingin mengekalkan kunci semasa ("Biarkan kosong untuk mengekalkan kunci semasa").
  3. Klik Dayakan / Nyahdayakan untuk menjedanya. Peristiwa yang masuk semasa ia dijeda akan disimpan. Jika anda mengaktifkannya semula dalam masa terdekat, ia akan dihantar.
  4. Klik Padam, kemudian sahkan "Padam webhook ini?".

Peraturan dan mesej:

  • Nama dan URL destinasi adalah wajib, dan sekurang-kurangnya satu peristiwa mesti diaktifkan. Jika tidak, anda akan melihat "Data tidak lengkap".
  • Alamat yang bukan https awam akan ditolak dengan mesej "Alamat https awam yang boleh kami capai".
Saya kehilangan kunci tandatangan.

Ia tidak boleh dipaparkan lagi. Edit webhook tersebut, taip kunci tandatangan baharu dalam ruangan "Kunci tandatangan", simpannya, dan gunakan kunci baharu itu pada pelayan anda.

Webhook saya telah dimatikan sedangkan saya tidak melakukannya.

SyBox mematikannya selepas pelayan anda gagal 20 kali berturut-turut selama lebih daripada satu jam. Lihat "Dimatikan dengan sendirinya" di atas: baiki pelayan anda, kemudian hidupkan semula webhook dalam masa 24 jam supaya peristiwa yang menunggu dapat dihantar.

Webhook saya langsung tidak menerima apa-apa data.

Klik "Hantar peristiwa ujian" pada kadnya dahulu, dan lihat pada "Penghantaran". Kemudian semak empat perkara ini. (1) Webhook diaktifkan. (2) Sekurang-kurangnya satu peristiwa dipilih. (3) Ia meliputi nombor WhatsApp yang betul, atau "Semua nombor". (4) Saluran mesej itu masuk adalah saluran yang dibawa oleh webhook (WhatsApp, Messenger, Instagram, Telegram, TikTok atau Live Chat; bukan emel atau SMS). Kemudian lihat status penghantaran terakhir pada kad.

Kad menunjukkan ralat merah seperti HTTP 404 atau 500.

SyBox berjaya menghubungi alamat anda, tetapi pelayan anda membalas dengan ralat. Sila semak alamat tersebut dan log pelayan anda.

Saya tidak boleh mencipta webhook. Sistem menyatakan saya tidak mempunyai kebenaran.

Untuk mencipta webhook atau mengaktifkannya semula, anda memerlukan kebenaran "Urus saluran" dan "Tunjukkan nombor kenalan". Sila hubungi pentadbir anda.