Webhook

Webhook #

Webhook dapat digunakan untuk menghasilkan pemberitahuan eksternal tentang perubahan pengguna dan/atau pelanggan. Pemberitahuan ini, bila dikombinasikan dengan REST API sangat penting untuk mengotomatiskan penyediaan pengguna dan menjaga sistem konfigurasi/penagihan eksternal tetap mutakhir.

Peristiwa web hook akan memicu peristiwa C.R.U.D pada pengguna dan pelanggan. REST API kemudian dapat digunakan oleh aplikasi penerima untuk mengkueri informasi spesifik tentang perubahan menggunakan Id yang disediakan dalam payload webhook.

Parameter #

Parameter Pilihan Deskripsi
Jenis entitas Pengguna, Pelanggan Entitas yang dapat diaktifkan oleh pemicu. Buat beberapa pemicu untuk menangkap perubahan Pengguna dan Pelanggan.
Peristiwa Dibuat / Diperbarui / Dihapus Pilih satu atau beberapa jenis peristiwa di mana pemicu akan diaktifkan. *Catatan: Jenis peristiwa yang menyebabkan pemicu disertakan dalam payload.
URL https:// Berikan HTTPS URL bahwa pelatuk akan memanggil saat ditembakkan.
Metode permintaan GET, POST, PUT Pilih metode permintaan yang diperlukan untuk webhook.
Format permintaan JSON, Data Formulir Pilih format permintaan yang diperlukan untuk webhook if POST atau PUT dipilih sebagai metode Permintaan.
Data muatan tambahan Pasangan kunci/nilai Jika diperlukan, informasi statis tambahan dapat ditambahkan ke muatan webhook. Masukkan data tambahan apa pun sebagai pasangan kunci/nilai sesuai kebutuhan.
Upaya coba lagi 0 - 10 Standar 1. Masukkan berapa kali webhook harus mencoba lagi jika suatu saat tidak berhasil
Hand Left warning
Konfigurasi pemicu webhook di-cache untuk meningkatkan performa. Setiap pemicu baru atau perubahan pada pemicu yang ada mungkin memerlukan waktu hingga 10 menit sebelum diterapkan.
Information Circle info
Batas waktu untuk permintaan webhook adalah 10 detik. Waktu antara upaya coba lagi sama dengan Nomor Percobaan x 2 Detik

Data Muatan #

Tabel di bawah ini menunjukkan data yang disediakan dalam payload pemicu.

Parameter Deskripsi
ID pemicu ID unik untuk pemicu permintaan kait web sedang diaktifkan.
Id ID entitas yang berubah (ID pengguna atau Id penyewa).
tenantId Id penyewa pelanggan yang terkait dengan peristiwa tersebut.
eventType Jenis peristiwa yang menghasilkan web hook. Baik buat, Pembaruan atau hapus
Data kustom Jika dikonfigurasi terhadap pemicu, informasi pasangan kunci/nilai payload tambahan akan diteruskan di sini.
Color Wand tip
triggerId dapat ditemukan dengan mengedit pemicu yang dikonfigurasi di Portal Reseller dan menyalin GUID dari akhir URL. misalnya https://reseller.myreports.com/en-GB/webhooks/00000000-0000-0000-0000-000000000000

Contoh JSON Payload: #

Contoh JSON format muatan untuk PUT/POST Permintaan:

{
    "triggerId": "00000000-0000-0000-0000-000000000000",
    "id": "1468547c-a945-41d4-95e3-ffffffffffff",
    "tenantId": "a0ea7445-df78-4487-ffffffffffff",
    "configurationType": "user",
    "eventType": "update",
    "customData": {
        "myitemkey1": "myitemval1",
        "myitemkey2": "myitemval2"
    }
}

Contoh muatan Data FORM #

Contoh payload Data Formulir untuk PUT/POST Permintaan:

[triggerId, 00000000-0000-0000-0000-000000000000], [tenantId, a0ea7445-df78-4487-ffffffffffff], [id, 1468547c-a945-41d4-95e3-ffffffffffff], [configurationType, user], [eventType, update],[myitemkey1, myitemval1], [myitemkey2, myitemval2]

Contoh GET minta #

Jika metode Request GET dikonfigurasi untuk Webhook, data payload diteruskan sebagai parameter string kueri dalam permintaan.

http://example.url.com?triggerId=00000000-0000-0000-0000-000000000000&tenantId=a0ea7445-df78-4487-ffffffffffff&id=1468547c-a945-41d4-95e3-ffffffffffff&configurationType=user&eventType=update&hook=get&myitemkey1=myitemval1&myitemkey2=myitemval2