Webhooks - Dokumen - Meta untuk Developer

Ringkasan

Webhooks memungkinkan aplikasi integrasi khusus untuk berlangganan peristiwa di Workplace dan menerima info terkini secara realtime. Saat terjadi perubahan di Workplace, permintaan HTTPS POST dikirim ke URL panggilan balik untuk setiap aplikasi integrasi khusus yang berlangganan topik Webhooks yang relevan.

Hal ini membuat aplikasi lebih efisien, karena aplikasi akan mengetahui kapan tepatnya perubahan terjadi dan tidak perlu bergantung pada permintaan Graph API yang berkelanjutan atau bahkan berkala untuk mendapatkan konten terbaru.

Dukungan Webhooks untuk Workplace disediakan oleh kerangka kerja yang sama yang mempersembahkan Webhooks untuk Facebook.

Berlangganan Topik Webhooks

Dialog Edit Integrasi Khusus menyediakan tab untuk setiap topik Webhooks yang tersedia untuk aplikasi di Workplace.

Tab Webhooks di dialog Edit Integrasi Khusus

Untuk menambahkan langganan Webhooks baru tentang topik tertentu, sediakan URL panggilan balik dan token verifikasi, lalu pilih kolom langganan yang Anda perlukan untuk fungsi yang akan disediakan oleh aplikasi Anda.

Anda hanya dapat berlangganan satu URL per topik Webhooks, tetapi Anda dapat menggunakan URL yang sama untuk beberapa topik.

Menangani Permintaan Verifikasi

Saat Anda menambahkan langganan baru, atau mengubah langganan yang sudah ada, server Facebook akan membuat permintaan GET ke URL panggilan balik untuk memverifikasi validitas server panggilan balik.

String kueri akan ditambahkan ke URL ini dengan parameter berikut:

hub.mode - String "subscribe" diteruskan di parameter ini
hub.challenge - String acak
hub.verify_token - Nilai verify_token Anda tentukan saat membuat langganan

Saat menerima permintaan HTTP GET di URL panggilan balik, Anda dapat menggunakan parameter verify_token untuk memvalidasi apakah permintaan berasal dari server Facebook.

Keamanan Webhooks

Semua panggilan Webhooks ke URL panggilan balik yang ditentukan developer dilakukan melalui HTTPS, memastikan keamanan tingkat transportasi untuk muatan Webhooks.

Untuk memberikan keamanan tambahan, header HTTPX-Hub-Signature-256 disertakan dalam setiap muatan POST, yang harus digunakan untuk memverifikasi bahwa muatan berasal dari server Facebook.

Untuk detail lengkap tentang perilaku ini, buka dokumentasi Kerangka Kerja Webhooks Facebook.

Topik Webhooks

Aktivitas di Workplace dikelompokkan ke dalam topik-topik. Setiap topik memiliki sejumlah kolom yang dipetakan ke peristiwa pada topik tertentu. Aplikasi dapat berlangganan pembaruan Webhooks pada setiap topik, dan untuk kolom tertentu dalam setiap topik.

Workplace saat ini menyediakan Webhooks untuk topik dan grup berikut:

Halaman

Informasi selengkapnya tersedia di Dokumen Referensi Topik Halaman.

Kolom Langganan	Perilaku
`mention`	Terpicu saat halaman integrasi khusus (bot) disebutkan dalam grup.
`messages`	Terpicu saat halaman integrasi khusus (bot) dikirimi pesan di Obrolan Workplace.
`message_deliveries`	Terpicu saat pesan yang dikirim oleh halaman integrasi khusus (bot) disampaikan.
`messaging_postbacks`	Terpicu saat tombol postback ditekan di Obrolan Workplace.
`message_reads`	Terpicu saat pesan dari halaman integrasi khusus (bot) dibaca oleh penerima.

Grup

Informasi selengkapnya tersedia di Dokumen Referensi Topik Grup.

Kolom Langganan	Perilaku
`posts`	Terpicu saat postingan ditambahkan, diperbarui, atau dihapus dalam grup.
`comments`	Terpicu setiap kali komentar baru ditambahkan, diperbarui, atau dihapus pada postingan grup.
`membership`	Terpicu saat keanggotaan grup berubah.

Pengguna

Informasi selengkapnya tersedia di Dokumen Referensi Topik Anggota.

Kolom Langganan	Perilaku
`status`	Terpicu saat seorang pengguna memposting atau mengedit pembaruan status di profilnya sendiri.
`events`	Terpicu setiap kali seorang pengguna membuat, menerima, atau menolak peristiwa.
`message_sends`	Terpicu setiap kali seorang pengguna mengirimkan pesan Obrolan Workplace.

Tautan

Informasi selengkapnya tersedia di Dokumen Pratinjau Terautentikasi.

Kolom Langganan	Perilaku
`preview`	Terpicu saat Workplace perlu mengambil informasi tentang URL.
`collection`	Hanya relevan untuk aplikasi pada daftar diizinkan yang mendukung navigasi Komposer Postingan hierarkis.

Keamanan

Informasi selengkapnya tersedia di Dokumen Referensi Topik Keamanan.

`sessions`

Peristiwa terpicu ketika seseorang login atau keluar dari Workplace.

Peristiwa Perilaku

Peristiwa	Perilaku
`log_in`	Pengguna telah login ke Workplace dengan kata sandi atau SSO, di www atau aplikasi seluler.
`log_out`	Pengguna telah keluar dari Workplace dengan kata sandi atau SSO, di www atau aplikasi seluler. Tidak termasuk dipaksa keluar yang diinisiasi oleh admin (Lihat `admin_force_log_out`)

log_in

Pengguna telah login ke Workplace dengan kata sandi atau SSO, di www atau aplikasi seluler.

log_out

Pengguna telah keluar dari Workplace dengan kata sandi atau SSO, di www atau aplikasi seluler.

Tidak termasuk dipaksa keluar yang diinisiasi oleh admin (Lihat admin_force_log_out)

`passwords`

Peristiwa terpicu saat seseorang mengubah kata sandinya atau meminta reset kata sandi.

Peristiwa	Perilaku
`password_change`	Kata sandi pengguna telah diubah, sebagai hasil dari menyelesaikan pemulihan kata sandi atau melalui pengaturan akun.
`password_reset_request`	Alur pemulihan sandi pengguna telah dimulai, dan kode telah dikirim ke alamat email pengguna.
`password_reset_wrong_code`	Pengguna salah memasukkan kode pemulihan reset kata sandi.
`password_reset_success`	Alur pemulihan kata sandi pengguna telah berhasil diselesaikan.

`admin_activity`

Peristiwa terpicu saat admin ditambahkan atau dihapus dari komunitas Workplace

Peristiwa	Perilaku
`admin_set_to_unclaimed`	Seorang admin telah mengatur status akun pengguna ke belum diklaim dari panel admin atau melalui API Pengelolaan Akun.
`admin_force_log_out`	Seorang admin telah memaksa pengguna untuk keluar di semua perangkat dari Panel Admin.
`admin_deactivate`	Seorang admin telah menonaktifkan akun dari Panel Admin atau melalui API Pengelolaan Akun.
`admin_activate_account`	Seorang admin telah mengaktifkan akun dari Panel Admin atau melalui API Pengelolaan Akun.
`force_password_reset`	Seorang admin telah memaksa pengguna untuk mereset kata sandi dari Panel Admin.
`admin_create_account`	Seorang admin telah membuat akun dari Panel Admin.

`two_factor`

Peristiwa terpicu ketika seseorang mengaktifkan atau menonaktifkan autentikasi dua faktor.

Peristiwa	Perilaku
`two_factor_enable`	Pengguna telah mengaktifkan autentikasi dua faktor dari tab Pengaturan. Ini tidak menangkap ketika seseorang mengonfirmasi ponsel tertentu, tetapi menunjukkan bahwa fitur itu diaktifkan.
`two_factor_disable`	Seorang pengguna telah menonaktifkan autentikasi dua faktor dari tab Pengaturan. Ini tidak menangkap ketika seseorang menonaktifkan autentikasi dua faktor untuk ponsel tertentu, tetapi menunjukkan bahwa fitur itu dinonaktifkan.