Webhook Keluar
Tolak peristiwa daripada FreeMaint ke sistem luaran anda secara masa nyata
5 minit bacaan
Webhook membolehkan FreeMaint menghantar POST ke URL yang anda kawal sebaik sahaja sesuatu berlaku, supaya sistem lain (ERP, pengebilan, inventori, perakaunan, saluran sembang) kekal selari tanpa sesiapa menaip semula. Konfigurasi dari /company-settings/webhooks. Starter dihadkan kepada 100 penghantaran/hari; Business ke atas tanpa had. Untuk rujukan muatan yang lengkap, lihat API & GraphQL > Webhook.
Peristiwa yang tersedia
- work_order.created — perintah kerja telah dicipta
- work_order.completed — perintah kerja bertukar kepada Selesai
- work_order.status_changed — perintah kerja bertukar ke mana-mana status; work_order.completed tetap dicetuskan juga
- request.created — permintaan penyelenggaraan telah dihantar
- request.status_changed — permintaan diluluskan, ditolak atau dibatalkan
- part.low_stock — alat ganti jatuh ke titik pesanan semula atau ke bawah
- part.out_of_stock — stok alat ganti mencecah sifar
- part.low_stock_summary — sekali sehari, alat ganti pada atau di bawah titik pesanan semula, termasuk yang tidak pernah bergerak
- part.out_of_stock_summary — sekali sehari, alat ganti yang stoknya sifar
- part.consumed — digunakan pada perintah kerja, atau dipulangkan daripadanya
- compliance.chain_divergence — rantaian cincang audit terputus (Enterprise)
- asset.downtime_started — satu pemberhentian mesin telah dibuka
- asset.downtime_ended — satu pemberhentian mesin telah ditutup
- report.daily_summary — kerja yang selesai pada hari itu, sekali sehari pada jam pilihan anda
- purchase_order.created — pesanan belian telah dicipta
- purchase_order.status_changed — pesanan belian bertukar ke status lain (diluluskan, dipesan, dibatalkan…)
- purchase_order.received — penghantaran telah diterima bagi pesanan belian, termasuk penghantaran separa
Semantik penghantaran
- POST dengan badan JSON: { event, timestamp, data }
- Pengepala X-FreeMaint-Signature — t=<saat unix>,v1=<heks>, dengan v1 ialah HMAC-SHA256 bagi «<t>.<badan mentah>» menggunakan rahsia webhook anda sebagai kunci. Sahkan pada setiap permintaan, terhadap badan mentah
- X-FreeMaint-Event dan X-FreeMaint-Delivery-Id turut dihantar
- Ralat rangkaian dan 5xx dicuba semula sehingga 3 kali dengan undur eksponen (kira-kira 2 s, 4 s, 8 s); 4xx ialah penolakan kekal dan tidak dicuba semula
- Setiap cubaan direkodkan di bawah webhook dengan status, kod respons dan bilangan cubaan — dan mana-mana penghantaran yang selesai boleh dihantar semula dari situ
- Gambar pilihan: dengan "Sertakan gambar" dihidupkan, acara "work_order" dan "request" membawa sehingga 4 pautan imej dalam medan "photos", sah selama 7 hari untuk sesiapa yang memilikinya — hidupkan hanya untuk titik akhir yang anda kawal
Konfigurasi
- Buka /company-settings/webhooks — Memerlukan kebenaran tetapan syarikat atau kebenaran "Mengurus integrasi".
- Klik «Tambah Webhook» — Beri nama, URL https:// dan tandakan peristiwa yang dikehendaki.
- Salin rahsia tandatangan — Ia dipaparkan SEKALI sahaja semasa penciptaan. Kemudian anda boleh menjana yang baharu melalui «Putar rahsia», yang membatalkan yang lama.
- Pantau penghantaran — Buka sejarah penghantaran webhook untuk mengesahkan peristiwa tiba dan menghantar semula yang gagal.
Had mengikut pelan
- Starter — 100 penghantaran/hari bagi setiap syarikat (pengira ditetapkan semula pada 00:00 UTC)
- Business — tanpa had
- Enterprise — tanpa had
- Pengira mengira CUBAAN: tiga webhook pada peristiwa sama menggunakan tiga unit
Petua
Sentiasa sahkan X-FreeMaint-Signature di bahagian pelayan, terhadap badan permintaan mentah — tanpanya anda tidak dapat membezakan peristiwa FreeMaint tulen daripada yang dipalsukan, dan part.consumed palsu boleh menggerakkan stok dalam ERP anda.
Artikel berkaitan
Adakah halaman ini membantu?