Integrasi: webhook keluar
Kirim event workspace (posting yang dipublikasikan, akun terputus...) ke sistem Anda sendiri sebagai permintaan HTTPS yang telah ditandatangani.
Pengaturan → Integrasi (alamat /app/settings/integrations) mengirim event dari workspace ini ke URL Anda, misalnya alat otomatisasi (Zapier, Make, n8n) atau server Anda sendiri. Hanya Pemilik dan Admin yang dapat melihat dan mengubahnya.
Langkah demi langkah: tambahkan endpoint
- Buka Pengaturan → Integrasi.
- Di URL endpoint ketik URL endpoint Anda, misalnya
https://your-system.example.com/omnibrand-hook. URL harus https dan dapat dijangkau di internet publik; jika tidak, baris merah menyebutkan masalahnya ("Alamat endpoint harus dimulai dengan https://. http:// biasa tidak diterima.", atau bahwa alamat tidak dapat dijangkau dari internet). - Di bawah Peristiwa centang acara yang diterima endpoint ini. Setiap kotak memiliki deskripsi sederhana dan nama acaranya, misalnya
post.published("Sebuah postingan diterbitkan"),post.failed,social_account.token_expiredatausocial_account.disconnected; Semua acara, termasuk yang ditambahkan nanti adalah*.workspace.createddaninvitation.acceptedjuga tersedia. Centang setidaknya satu, atau formulir menampilkan "Pilih setidaknya satu acara." - Klik Tambah endpoint.
- Rahasia penandatanganan (salin sekarang - hanya ditampilkan sekali): muncul bersama rahasia, di atas formulir; halaman akan menggulir ke atasnya sehingga Anda juga melihatnya di ponsel. Jika endpoint ditolak, pesan merah muncul di tempat yang sama dan halaman akan bergeser ke sana. Salin rahasia ke sistem penerima Anda sekarang; OmniBrand tidak akan pernah menampilkannya lagi (hanya empat karakter terakhir). Salin rahasia di sebelahnya untuk Anda.
- Klik Kirim uji pada endpoint. Anda melihat ✓ delivered dengan status HTTP yang dikembalikan server Anda. Jika gagal, Anda akan melihat "Not delivered: your server answered [status]." dengan apa yang harus diperbaiki, misalnya untuk 405 Metode Tidak Diizinkan "Harus menerima permintaan POST di alamat ini.", untuk 404 Not Found "Tidak ada jawaban di alamat ini. Periksa URL.", untuk pengalihan "Itu mengalihkan ke alamat lain, dan webhook tidak pernah mengikuti pengalihan. Daftarkan URL akhir sebagai gantinya."; atau, ketika server sama sekali tidak dapat dihubungi, "Tidak dikirim: server Anda tidak dapat dihubungi ([alasan]). Periksa URL dan apakah server tersebut online." Tautan Cara kerja webhook membuka artikel ini.
Setiap titik akhir
- URL dan lencana aktif atau nonaktif.
- "event: ... · secret ••••1234", dengan setiap event sesuai deskripsinya (misalnya "Sebuah postingan telah dipublikasikan"), ditambah "· N kegagalan berturut-turut" ketika upaya pengiriman gagal dan "· N menunggu percobaan ulang" sementara event menunggu percobaan berikutnya.
- Garis merah "N pengiriman gagal - buka Riwayat pengiriman untuk mengirimnya lagi." ketika peristiwa berhenti (lihat Riwayat pengiriman dan Pengiriman Ulang di bawah).
- Diaktifkan / Dinonaktifkan menjeda atau melanjutkan pengiriman. Saat perubahan disimpan, kartu bertuliskan "Working..." dan Kirim uji test serta Hapus menunggu; jika switch atau Hapus gagal, alasannya muncul dengan warna merah di bagian bawah kartu endpoint tersebut, dan halaman akan bergeser ke sana.
- Kirim uji mengirim event bernama 'webhook.test' sekali (tidak dicoba ulang dan tidak disimpan dalam riwayat).
- Riwayat pengiriman membuka pengiriman terbaru di endpoint (tombol Sembunyikan riwayat pengiriman menutupnya).
- Hapus bertanya "Hapus webhook ke (alamat)? Acara langsung berhenti dikirim ke sana dan rahasia penandatanganannya hilang selamanya. Untuk menjedanya, matikan sakelarnya." Jendela berjudul Hapus webhook?; klik Hapus untuk langsung menghapus endpoint, atau Batal untuk menyimpannya.
Apa yang diterima server Anda
POST dengan isi JSON: id (id event - gunakan untuk mengabaikan duplikat), event (misalnya post.published), occurredAt, dan data (detail event). Header:
X-OmniBrand-Signature:sha256=diikuti oleh HMAC-SHA256 dari bodi mentah, dikunci dengan rahasia tanda tanganmu.X-OmniBrand-TimestampdanX-OmniBrand-Signature-V2: HMAC-SHA256 dari timestamp, titik, dan isi - gunakan untuk menolak replay lama.
Jawab dengan status 2xx apa pun dalam 5 detik.
Mengulang: berapa lama OmniBrand terus mencoba
Setiap event disimpan sebelum dikirim, jadi tidak ada yang hilang jika server Anda - atau server kami - melakukan restart. Ketika server Anda tidak menjawab status 2xx dalam waktu 5 detik (error, timeout, redirect, atau jawaban non-2xx), event akan dicoba lagi setelah sekitar 1 menit, 5 menit, 15 menit, 30 menit, 1 jam, 2 jam, 4 jam, 8 jam, dan 12 jam - 10 percobaan selama sekitar 28 jam. Setiap tunggu bervariasi hingga 20% sehingga percobaan ulang tidak semua tiba sekaligus. Karena percobaan ulang dapat tiba setelah event berikutnya, gunakan 'id' untuk mengabaikan duplikat dan 'occurredAt' untuk memesan acara.
Jika semua 10 percobaan gagal, pengiriman akan ditandai Gagal dan tetap ada di riwayat selama 30 hari, di mana Anda dapat mengirimnya lagi.
Riwayat pengiriman dan pengiriman ulang
- Di endpoint, klik Riwayat pengiriman. Pengiriman terbaru mencantumkan 30 hari terakhir, yang terbaru duluan.
- Setiap baris menampilkan status badge - Terkirim, Mencoba ulang atau Gagal - nama event, saat terjadi, "Attempt N of 10", untuk Mencoba ulang pada waktu "next try", dan untuk yang tidak lolos "Last answer:" dengan apa yang dijawab server Anda (misalnya "HTTP 503" atau "No answer within 5 s").
- Centang Hanya yang gagal untuk melihat yang gagal; Tampilkan yang lebih lama lebih banyak muatan lama. Dengan tidak ada, tertulis "Tidak ada pengiriman gagal dalam 30 hari terakhir. Pengiriman yang masih dicoba ulang tidak dihitung sebagai gagal." (Pengiriman Mencoba ulang belum gagal).
- Untuk mengirim lagi, klik Kirim ulang pada barisnya. Dikirim segera: Anda melihat "Delivered." atau "Belum dikirim (jawaban). Akan dicoba lagi secara otomatis." - event redelivered memulai run baru sebanyak 10 percobaan.
- Untuk mengirim semuanya lagi setelah memperbaiki server Anda, klik Kirim ulang semua yang gagal (ditampilkan saat ada pengiriman gagal). Anda melihat "N pengiriman gagal antre dan keluar dalam satu menit."
Redeliver membutuhkan endpoint diaktifkan; saat Nonaktif , tombol-tombol menunggu dan riwayat mengatakan "Endpoint ini dinonaktifkan. Nyalakan saklarnya untuk redeliver." Event yang tiba saat endpoint dinonaktifkan tidak dikirim atau disimpan.
Jika sesuatu salah
- Pengalihan tidak pernah diikuti; daftarkan URL akhir. Jika URL Anda mengarahkan, pengujian mengatakan "Tidak dikirim: server Anda menjawab 301 Dipindahkan Secara Permanen. Alamat tersebut dialihkan ke alamat lain, dan webhook tidak pernah mengikuti pengalihan. Daftarkan URL akhir sebagai gantinya." (dengan status yang dikirim server Anda).
- Ketika setiap percobaan ke endpoint gagal selama sehari penuh (setidaknya 20 percobaan berturut-turut), endpoint secara otomatis nonaktif dan admin diberi tahu. Pengiriman yang menunggu akan ditandai Gagal. Perbaiki penerima, kembalikan switch ke Diaktifkan, lalu buka Riwayat pengiriman dan klik Kirim ulang semua yang gagal.
Akses API (untuk developer)
Di bagian bawah halaman ada kartu Akses API (untuk developer): "Hubungkan OmniBrand ke sistem Anda sendiri, Zapier, atau Make untuk membuat postingan, menambahkan kontak, atau membaca analitik secara otomatis." Di paket Agency dan Enterprise, kartu ini berisi kunci API Anda untuk API publik (lihat Akses API). Di paket lain, kartu ini bertuliskan "Akses API tersedia di paket Agency." dengan tautan Lihat paket. Webhook di halaman ini berfungsi di semua paket.
Bagus untuk diketahui
- Endpoint hanya menerima event dari workspace ini, plus event di seluruh akun (event penagihan dan akun).
- Ruang kerja tempat Anda berada saat menambahkan endpoint adalah tempat yang menjadi miliknya.