Pengiriman data kegiatan untuk koneksi baru
Untuk mengirim data kuis atau kegiatan ke sistem sendiri, buat pengiriman data kegiatan pada bagian Pengembang dalam pengaturan akun. Koneksi ini mengirim peristiwa dari proyek yang dipilih ke URL penerima.
Periksa dahulu: pengiriman data kegiatan tersedia untuk semua akun. Membuat koneksi baru memerlukan paket berbayar yang masih aktif. Webhook lama tingkat akun tetap dapat ditambahkan atau diedit, dan keduanya dapat digunakan bersamaan. Panduan versi lama di bagian bawah menjelaskan pengaturan, format data, dan keamanan Webhook lama.
Perlu memperbarui tag anggota SHOPLINE atau memberikan hadiah? Pilih jalur pengaturan dahulu
Untuk memberi tag anggota SHOPLINE berdasarkan hasil kuis, atau memberikan kredit toko, poin anggota, dan kupon yang dapat diklaim, pemilik proyek yang memiliki akses Beta otomatisasi SHOPLINE dapat memeriksa apakah fitur bawaan Otomatisasi kampanye SHOPLINE sesuai. Tindakan bawaan ini tidak memerlukan sistem penerima Webhook tersendiri. Ikuti panduan login anggota SHOPLINE dan otomatisasi kampanye, lalu periksa persyaratan proyek dan otorisasi toko.
Untuk mengirim jawaban atau data kegiatan ke CRM dan sistem keanggotaan sendiri, atau menyerahkan pemrosesan bisnis berikutnya kepada sistem sendiri, gunakan pengiriman data kegiatan. Login anggota merek, otomatisasi SHOPLINE, dan pengiriman data kegiatan memiliki pengaturan serta persyaratan akses yang terpisah.
Jika penerima Webhook sendiri sudah memberikan hadiah yang sama, tentukan pihak yang bertanggung jawab sebelum mengaktifkan otomatisasi bawaan. Jangan sampai kedua sistem masing-masing memberikan hadiah tersebut.
Mulai dari pengiriman data kegiatan
- Buka bagian Pengembang dalam pengaturan akun, lalu buat pengiriman data kegiatan.
- Isi URL penerima. Untuk koneksi baru, pilih Format baru.
- Pilih peristiwa dan proyek atau kartu loyalitas yang diizinkan mengirimkannya.
- Simpan pengaturan, lalu picu peristiwa dari kegiatan yang sebenarnya untuk menguji penerima.
Setiap koneksi memiliki secret penandatanganan sendiri. Koneksi baru tidak memakai API Key akun dan tidak menyediakan peristiwa Dimulai. Peristiwa yang tersedia mencakup Jawaban selesai, Misi selesai, Poin benar-benar ditambahkan, dan Penukaran platform, sesuai persyaratan sumber dan identitasnya. HTTP 200 hanya berarti penerima menerima data, bukan bahwa CRM sudah memberi tag, kupon, atau memperbarui anggota.
Untuk pilihan identitas, proyek penghasil peristiwa, format baru maupun format yang sudah ada, tanda tangan, dan deduplikasi, ikuti panduan pengiriman data kegiatan merek. Jangan menerapkan contoh tanda tangan API Key pada bagian legacy kepada koneksi baru.
Webhook lama: referensi pengaturan yang sudah ada
Batas versi: bagian ini menjelaskan Webhook lama tingkat akun, termasuk API Key, peristiwa Dimulai/Selesai, kolom payload, dan tanda tangan. Untuk koneksi pengiriman data kegiatan yang baru, ikuti langkah di atas. Kedua jenis koneksi dapat digunakan bersamaan, tetapi format dan kunci penandatanganannya berbeda.
Referensi legacy berikut menjelaskan Webhook tingkat akun yang menggunakan API Key untuk mengirim data respons dan hasil ke sistem penerima. Ini bukan langkah membuat koneksi pengiriman data kegiatan yang baru.
Gunakan bagian ini untuk memahami kolom, waktu pemicu, dan tanda tangan pada pengaturan lama yang sudah ada. Untuk pengaturan baru dalam jalur pengiriman data kegiatan, kembali ke bagian awal artikel.
Daftar isi
- Referensi pengaturan Webhook lama dan contoh data
- Kolom data apa saja yang disertakan?
- Data apa yang tidak dapat dikirim?
- Mekanisme keamanan yang disarankan
Referensi pengaturan Webhook lama dan contoh data
- Jadilah pengguna berbayar untuk mengakses fitur ini selama masa aktif langganan. (Cara memilih paket)
- Buka halaman “Profil pemain” dan masuk ke “Pengembang.”
- Jika baru pertama kali membuka Pengembang, buat API Key baru.
- Setelah API Key dibuat, Anda dapat mulai mengatur peristiwa Webhook.
- Webhook dapat dipicu pada dua titik. Pilih sesuai kebutuhan:
- Aktifkan peristiwa “Dimulai”: Saat pemain masuk ke halaman pertanyaan.
- Aktifkan peristiwa “Selesai”: Saat pemain menyelesaikan kuis dan mencapai halaman hasil. (Definisi penyelesaian)
- Setelah pengaturan berhasil, permintaan POST dikirim ke URL yang Anda tentukan setiap kali syarat pemicu terpenuhi.
Contoh payload JSON
{
"data": {
"answerId": "o1VepeqjgSbe6XxeJlZs",
"quizId": "nvCwKZUvGw43KTrMth3V",
"startedAt": "2024-04-11T08:44:10.782Z",
"ref": {
"id": "gI11io",
"label": "Channel Name"
},
"utm": {
"campaign": "",
"id": "",
"source": ""
},
"fromQuiz": {
"answerId": "",
"quizId": ""
},
"finishedAt": "2024-04-11T08:44:10.943Z",
"result": {
"id": "default",
"label": "Result Name"
},
"duration": 2513,
"answers": [
{
"id": "VvsB5w",
"duration": 1297,
"value": "adaff",
"title": "Question 1"
},
{
"id": "WSgpX9",
"duration": 1217,
"value": "Other",
"other": "User's custom response",
"title": "Question 3"
}
]
},
"type": "finish",
"timestamp": "2024-04-11T08:50:57.315Z"
}
Kolom data apa saja yang disertakan?
Kolom data respons umum:
| data | Data respons kuis (dijelaskan di bawah) |
| type | Jenis peristiwa (“start” atau “finish”) |
| timestamp | Waktu dalam format ISO 8601 |
Kolom data bersama untuk semua jenis peristiwa:
| answerId | ID respons unik |
| quizId | ID kuis |
| startedAt | Waktu mulai kuis |
| ref | Sumber kanal (dijelaskan di bawah) |
| utm | Data pelacakan UTM (dijelaskan di bawah) |
| fromQuiz | Sumber modul lain (dijelaskan di bawah) |
Kolom khusus peristiwa “kuis selesai”:
| finishedAt | Waktu selesai (format ISO) |
| result | Hasil kuis |
| duration | Jumlah waktu yang dihabiskan (dalam milidetik) |
| answers | Array jawaban individual |
Kolom untuk answers:
| id | ID pertanyaan |
| duration | Waktu menjawab (ms) |
| value | Jawaban yang dipilih |
| other | Respons kustom yang dimasukkan pengguna |
| title | Judul pertanyaan |
Kolom untuk ref (sumber kanal):
| id | ID URL kanal |
| label | Label kanal yang diatur dalam editor |
Kolom untuk utm (memerlukan fitur lanjutan “Ekspor catatan UTM”):
| campaign | utm_campaign |
| id | utm_id |
| source | utm_source |
Kolom untuk fromQuiz (memerlukan fitur lanjutan “Tautkan proyek lain”):
| answerId | ID respons sumber |
| quizId | ID kuis sumber |
💡 Jika kuis menggunakan login sosial atau anggota, payload dapat menyertakan oauthUser. Jika catatan anggota ditemukan, id mengidentifikasi anggota tersebut dan selalu disertakan. email dan nama anggota hanya ditambahkan jika proyek memiliki izin fitur lanjutan OAuth, yaitu “Catat email pemain dari login sosial”. Fitur “Kumpulkan data pemain di halaman hasil” saja tidak memberi izin untuk memperoleh data kontak dari login ini. provider juga memerlukan izin fitur lanjutan OAuth yang sama. Tanpa izin tersebut, jangan mengandalkan kolom email, nama, atau penyedia login dalam data anggota ini. Jika catatan anggota tidak ditemukan, oauthUser bisa bernilai null, jadi tangani keadaan tersebut pada penerima Anda.
Untuk mengatur LINE Login sendiri bagi keperluan ini, lihat Cara menghubungkan OAuth untuk autentikasi login proyek OOOPEN Lab
Data apa yang tidak dapat dikirim?
Karena pemicu terbatas pada peristiwa “dimulai” dan “selesai”, data yang dikirim setelah kuis selesai, seperti respons formulir opsional, kolom pengumpulan calon pelanggan, atau skor papan peringkat kuis berbasis skor, tidak dapat dikirim melalui Webhook.
Mekanisme keamanan yang disarankan
Pengiriman Webhook menyertakan header x-ooopenlab-signature, yang dapat digunakan untuk memverifikasi bahwa notifikasi berasal dari OOOPEN Lab.
Langkah verifikasi:
- Ubah objek data (hanya bagian JSON data, bukan seluruh payload) menjadi string JSON. Gunakan API Key Anda dengan algoritme HMAC-SHA256 untuk menghasilkan digest heksadesimal.
- Jika nilai heksadesimal tersebut cocok dengan header x-ooopenlab-signature, data terverifikasi.
Contoh
Jika datanya adalah {“test”:123} dan API Key adalah abcdef0123, tanda tangan heksadesimal yang dihasilkan adalah: c6dddde7ffbf0c651277f40b52cc8a07d80493982eaa6a10b7ab30bd6d9d4fe7
Contoh kode (Node.js)
const crypto = require('crypto');
const key = 'abcdef0123';
const data = '{"test":123}';
const signature = crypto
.createHmac("sha256", key)
.update(data)
.digest("hex");
// signature === 'c6dddde7ffbf0c651277f40b52cc8a07d80493982eaa6a10b7ab30bd6d9d4fe7'
Daftar sebagai kreator sekarang dan mulai membuat proyek secara gratis!
Daftar atau masuk sebagai kreator untuk mulai membuat dan memublikasikan proyek dengan paket gratis.
Paket gratis memiliki batasan fitur dan menyertakan iklan. Lihat rincian serta perbandingan fitur di halaman paket. Pilih paket berbayar jika Anda memerlukan fitur yang tidak tersedia dalam paket gratis.