Webhook
Di halaman ini 9 bagian
Webhook membuat Localtonet memanggil URL milik Anda saat sebuah perangkat (AuthToken) atau tunnel terhubung atau terputus. Gunakan untuk memberi tahu tim Anda, me-restart layanan, atau menjaga halaman status Anda sendiri tetap terbaru.
Cara kerjanya #
- Webhook dimiliki oleh sebuah grup token. Webhook memantau AuthToken dalam grup itu, tunnel milik token tersebut, atau keduanya, sesuai pilihan Anda.
- Saat status token atau tunnel yang dipantau berubah menjadi terhubung atau terputus, Localtonet mengirim permintaan HTTP
POSTdengan isi JSON kecil ke URL Anda. - Anda memilih salah satu dari dua peristiwa: terhubung, terputus, atau keduanya.
Sebelum memulai #
- Grup token yang berisi AuthToken yang ingin Anda pantau. Buat grup di Token Saya; lihat AuthToken.
- Endpoint HTTP atau HTTPS yang dapat dijangkau dari internet dan menerima permintaan
POSTdengan isi JSON. - Dasbor akun Anda sendiri. Item menu Webhook tidak ditampilkan saat Anda bekerja di dasbor tim.
Membuat webhook #
-
Buka Webhook #
Buka Webhook di menu dasbor.
-
Pilih hal yang ingin diberitahukan #
Pengaturan Fungsinya Aktifkan Webhook Token Mengirim permintaan saat AuthToken dalam grup terhubung atau terputus, yaitu saat klien Localtonet di perangkat itu online atau offline. Aktifkan Webhook Tunnel Mengirim permintaan saat tunnel milik AuthToken dalam grup terhubung atau terputus. Kirim Saat Terhubung Mengirim permintaan untuk perubahan menjadi terhubung. Kirim Saat Terputus Mengirim permintaan untuk perubahan menjadi terputus. Grup Auth Token Grup token yang dipantau. Wajib diisi. URL Webhook Alamat yang dipanggil Localtonet. Wajib diisi. Aktifkan setidaknya satu dari dua jenis webhook dan setidaknya satu dari dua jenis notifikasi.
-
Buat #
Pilih Buat. Webhook muncul di daftar di bawah formulir.
Daftar webhook #
Setiap baris menampilkan Webhook Token, Webhook Tunnel, Nama Grup, URL, Notifikasi Terhubung, dan Notifikasi Terputus, dengan setiap sakelar ditampilkan sebagai Aktif atau Pasif. Tombol hapus di kolom Aksi menghapus webhook setelah Anda mengonfirmasi.
Webhook tidak dapat diedit. Untuk mengubah URL, grup, atau sakelarnya, hapus lalu buat yang baru. Anda dapat membuat beberapa webhook untuk grup yang sama, misalnya satu URL untuk koneksi dan URL lain untuk pemutusan.
Permintaan yang dikirim Localtonet #
| Bagian | Nilai |
|---|---|
| Metode | POST |
| Tipe konten | application/json; charset=utf-8 |
| Isi | Objek JSON dengan empat kolom di bawah. |
| Kolom | Arti | Nilai |
|---|---|---|
Id | Mengidentifikasi token atau tunnel yang menjadi subjek peristiwa. | Untuk Type Token: mengidentifikasi AuthToken. Untuk Type Tunnel: ID numerik tunnel, dikirim sebagai string. ID ini sama dengan ID yang dipakai API sebagai tunnelId. |
ActionDate | Saat Localtonet mencatat perubahan tersebut. | Tanggal dan waktu dalam format ISO 8601 |
Type | Jenis objeknya. | Token atau Tunnel |
Status | Status yang baru. | Connected atau Disconnected |
Peristiwa token:
{
"Id": "<YOUR_TOKEN>",
"ActionDate": "2026-01-15T10:30:00.1234567+03:00",
"Type": "Token",
"Status": "Disconnected"
}Peristiwa tunnel:
{
"Id": "<TUNNEL_ID>",
"ActionDate": "2026-01-15T10:31:12.7654321+03:00",
"Type": "Tunnel",
"Status": "Connected"
}Pengiriman #
- Panggilan yang gagal tidak diulang, jadi endpoint Anda harus tersedia dan menjawab dengan cepat.
- Permintaan tidak memiliki header tanda tangan atau rahasia. Untuk memastikan panggilan berasal dari webhook Anda, letakkan nilai acak yang panjang di URL, misalnya sebagai segmen path atau parameter query, lalu periksa di penerima Anda.
- Pemutusan dilaporkan saat Localtonet mencatat bahwa klien sudah tidak ada, yang bisa sedikit lebih lambat dari saat perangkat kehilangan koneksinya.
- Urai
ActionDatedengan parser ISO 8601 standar dan gunakan offset yang dibawanya; jangan berasumsi zona waktu tetap.
Contoh penerima #
Framework web apa pun dapat dipakai. Penerima hanya perlu membaca isi JSON dan menjawab dengan status berhasil. Versi minimal dengan Node.js tanpa dependensi:
const http = require('http');
http.createServer((req, res) => {
let body = '';
req.on('data', chunk => body += chunk);
req.on('end', () => {
if (req.method === 'POST' && req.url === '/localtonet/<YOUR_SECRET>') {
const event = JSON.parse(body);
console.log(event.Type, event.Status, event.ActionDate);
}
res.writeHead(200);
res.end();
});
}).listen(8080);Dengan penerima ini, URL Webhook adalah https://<YOUR_HOST>/localtonet/<YOUR_SECRET>.
Menguji webhook Anda #
- Masukkan satu AuthToken dari perangkat uji ke grup token webhook.
- Jalankan klien Localtonet di perangkat itu dengan token tersebut. Jika Kirim Saat Terhubung aktif, endpoint Anda menerima
TypeToken,StatusConnected. - Hentikan klien dengan Ctrl + C. Endpoint Anda menerima
StatusDisconnected. - Jika Aktifkan Webhook Tunnel aktif, mulai dan hentikan tunnel milik token itu di Tunnel Saya untuk mendapatkan peristiwa tunnel.
Belum punya endpoint publik? Jalankan penerima di komputer Anda dan publikasikan dengan tunnel HTTP Localtonet pada AuthToken yang berbeda dari yang Anda pantau. Inspektur permintaan tunnel kemudian menampilkan setiap panggilan webhook; lihat Log dan inspeksi.
Pemecahan masalah #
"Aktifkan setidaknya satu jenis webhook." atau "Aktifkan setidaknya satu jenis notifikasi."
Aktifkan Aktifkan Webhook Token atau Aktifkan Webhook Tunnel, dan Kirim Saat Terhubung atau Kirim Saat Terputus, sebelum Anda memilih Buat.
"Grup wajib diisi!"
Pilih grup token di bawah Grup Auth Token. Jika daftar kosong, buat grup di Token Saya lalu tambahkan token Anda ke dalamnya.
Tidak ada permintaan yang masuk
Periksa bahwa AuthToken perangkat adalah anggota grup yang dipantau webhook, bahwa sakelar yang sesuai menampilkan Aktif di daftar, dan bahwa URL dapat dijangkau dari internet (bukan localhost atau alamat privat). Uji sendiri URL tersebut:
curl -X POST "<YOUR_WEBHOOK_URL>" \
-H "Content-Type: application/json" \
-d '{"Id":"test","ActionDate":"2026-01-15T10:30:00+00:00","Type":"Token","Status":"Connected"}'Saya menerima peristiwa token tetapi tidak ada peristiwa tunnel
Webhook Tunnel harus Aktif untuk webhook, dan tunnel harus milik AuthToken yang ada di grup.