Webhooks

Ringkasan

Webhooks memungkinkan aplikasi integrasi kustom untuk berlangganan peristiwa di Workplace dan menerima pembaruan secara realtime. Saat terjadi perubahan di Workplace, permintaan HTTPS POST dikirim ke URL telepon balik untuk setiap aplikasi integrasi kustom 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 mendukung Webhooks untuk Graph API.

Berlangganan Topik Webhooks

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

Bagian Webhooks dalam dialog Edit Integrasi Kustom

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

Menangani Permintaan Verifikasi

Saat Anda menambahkan langganan baru, atau mengubah langganan yang sudah ada, server Meta akan membuat permintaan GET ke URL telepon balik untuk memverifikasi validitas server telepon 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 yang Anda tentukan saat membuat langganan

Setiap kali endpoint menerima permintaan verifikasi, endpoint itu harus:

• Memverifikasi bahwa nilai hub.verify_token cocok dengan string yang Anda atur di kolom Verifikasikan Token saat Anda mengonfigurasi Webhooks.
• Menanggapi dengan nilai hub.challenge.

Keamanan Webhooks

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

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

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

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

Berlangganan Webhooks menggunakan panggilan API

Panggilan API untuk membaca atau mengubah langganan Webhooks harus dilakukan menggunakan token aplikasi, bukan token integrasi kustom biasa. Token aplikasi dapat dibuat dengan menggabungkan ID aplikasi, simbol '|', dan rahasia aplikasi.

Contoh:

Mendapatkan langganan Webhooks saat ini (menggunakan token aplikasi)

GET graph.facebook.com
  /{app-id}/subscriptions
    &access_token={your_app_token}

Menambahkan langganan Webhooks baru (menggunakan token aplikasi)

POST graph.facebook.com
  /{app-id}/subscriptions
    ?object=page
    &fields=mention,messages
    &callback_url={your-url}
    &verify_token={your-verify-token}
    &access_token={your_app_token}

Memecahkan Masalah Langganan Halaman/Aplikasi

Jika Webhooks tidak diterima seperti yang diharapkan, direkomendasikan untuk memeriksa apakah langganan antara halaman dan aplikasi telah disiapkan dengan benar. Ini seharusnya disiapkan secara otomatis, tetapi dalam beberapa kasus, penyiapan dapat gagal. Contoh: jika penayangan Webhooks gagal dalam periode waktu yang lama, langganan ini dapat dihapus. Untuk aplikasi pihak ketiga, ini akan menghasilkan peringatan di dasbor aplikasi.

Untuk memeriksa langganan ini, panggilan API berikut tersedia:

Mendapatkan langganan aplikasi/halaman saat ini (menggunakan token halaman)

GET graph.facebook.com
  /me/subscribed_apps?access_token={your_page_token}

Untuk membuat ulang langganan ini, panggilan API berikut tersedia:

Membuat ulang langganan aplikasi/halaman saat ini (menggunakan token halaman)

POST graph.facebook.com
  /me/subscribed_apps?access_token={your_page_token}
	{"subscribed_fields": ["messages"...]}

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.

Grup

Informasi selengkapnya tersedia di Dokumen Referensi Topik Grup.

Pengguna

Informasi selengkapnya tersedia di Dokumen Referensi Topik Anggota.

Keamanan

Informasi selengkapnya tersedia di Dokumen Referensi Topik Keamanan.

admin_activity

Peristiwa terpicu saat admin ditambahkan atau dihapus dari komunitas Workplace

compromised_credentials

Peristiwa terpicu ketika kami menduga bahwa kata sandi Workplace dari beberapa akun pengguna di sebuah komunitas mungkin berisiko bocor.

files

Peristiwa terpicu setelah aktivitas file Workplace.

groups

Peristiwa terpicu saat seseorang membuat atau bergabung dengan Grup Multi-Perusahaan Workplace.

integrations

Peristiwa terpicu saat admin membuat atau mengubah properti integrasi.

invites

Peristiwa terpicu saat seseorang bergabung ke Workplace melalui undangan mandiri.

passwords

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

sessions

Peristiwa terpicu ketika seseorang login atau logout dari Workplace.

two_factor

Peristiwa terpicu ketika seseorang mengaktifkan atau menonaktifkan autentikasi dua faktor.

reseller_events

Peristiwa terkait reseller.

Tautan

Informasi selengkapnya tersedia di Dokumen Referensi Topik Tautan

Galeri Pengetahuan

Informasi selengkapnya tersedia di Dokumen Graph API Kategori Galeri Pengetahuan.