Mencipta webhook

Webhook ialah alat untuk mendapatkan dan menyimpan data daripada peristiwa tertentu. Webhook membolehkan anda mendaftar URL https:// tempat data peristiwa boleh disimpan dalam format JSON atau XML. Webhook biasa digunakan atas sebab yang berikut:

• Membuat pesanan
• Menukar harga produk
• Memberitahu pelanggan IM atau kelui anda apabila anda berada di luar talian
• Mengumpulkan data untuk pergudangan data
• Mengintegrasikan perisian perakaunan anda
• Menapis item pesanan dan memaklumkan pelbagai pengirim tentang pesanan tersebut
• Mengalih keluar data pelanggan daripada pangkalan data anda apabila mereka menyahpasang aplikasi anda

Nota

Anda menerima e-mel pada alamat e-mel pemilik kedai apabila webhook gagal. E-mel hanya dihantar apabila webhook dicipta oleh aplikasi daripada Shopify App Store atau oleh aplikasi tersuai. Jika destinasi webhook berulang kali mengembalikan respons status bukan 200, maka langganan webhook dipadamkan secara automatik daripada pentadbir Shopify anda.

Petua

Untuk penyelesaian masalah lanjutan berkaitan isu webhook, pembangun boleh merujuk panduan Penyelesaian masalah webhook dalam dokumentasi pembangun.

Peristiwa webhook yang disokong

Apabila mencipta webhook, anda boleh memilih daripada mana-mana peristiwa yang disenaraikan. Sebagai contoh, jika anda ingin mencipta webhook yang dihantar setiap kali pesanan telah dibayar, maka pilih Pembayaran pesanan. Untuk contoh yang lain, jika anda ingin mencipta webhook yang dihantar setiap kali sifat kedai dikemaskinikan, maka pilih Kemas kini kedai.

Jadual yang menyenaraikan peristiwa webhook yang disokong yang tersedia dalam pentadbir Shopify.

Kategori	Peristiwa
Troli	Penciptaan troli Kemas kini troli
Pembayaran	Penciptaan pembayaran Pemadaman pembayaran Kemas kini pembayaran
Koleksi	Penciptaan koleksi Pemadaman koleksi Kemas kini koleksi
Pelanggan	Kemas kini persetujuan pemasaran SMS pelanggan Kemas kini tetapan akaun pelanggan Penciptaan pelanggan Pemadaman pelanggan Penyahdayaan pelanggan Kemas kini persetujuan pemasaran e-mel pelanggan Pendayaan pelanggan Penciptaan kumpulan pelanggan Pemadaman kumpulan pelanggan Kemas kini kumpulan pelanggan Tag pelanggan ditambahkan Tag pelanggan dialih keluar Kemas kini pelanggan
Diskaun	Penciptaan diskaun Pemadaman diskaun Kemas kini diskaun
Pesanan draf	Penciptaan pesanan draf Pemadaman pesanan draf Kemas kini pesanan draf
Pemenuhan	Penciptaan pemenuhan Pesanan pemenuhan tidak dapat dilengkapkan oleh Perkhidmatan Pemenuhan Item baris pesanan pemenuhan disediakan untuk pengambilan Pesanan pemenuhan dialihkan Pesanan pemenuhan ditangguhkan Pesanan pemenuhan dijadualkan semula Pesanan pemenuhan yang dijadualkan telah genap masa Penghalaan pesanan bagi pesanan pemenuhan selesai Pesanan pemenuhan dibatalkan Permintaan pembatalan pesanan pemenuhan diterima Permintaan pembatalan pesanan pemenuhan ditolak Permintaan pembatalan pesanan pemenuhan diserahkan Permintaan pemenuhan bagi pesanan pemenuhan diterima Permintaan pemenuhan bagi pesanan pemenuhan ditolak Permintaan pemenuhan bagi pesanan pemenuhan diserahkan Penangguhan pesanan pemenuhan dilepaskan Item baris pesanan pemenuhan disediakan untuk penghantaran tempatan Pesanan pemenuhan digabungkan Pesanan pemenuhan dipisahkan Kemas kini pemenuhan
Inventori	Penciptaan barang inventori Pemadaman barang inventori Kemas kini barang inventori Sambungan tahap inventori Pemotongan tahap inventori Kemas kini tahap inventori
Lokasi	Pengaktifan lokasi Penciptaan lokasi Penyahaktifan lokasi Pemadaman lokasi Kemas kini item lokasi
Pasaran	Penciptaan pasaran Pemadaman pasaran Kemas kini pasaran
Pesanan	Pembatalan pesanan Penciptaan pesanan Pemadaman pesanan Sunting pesanan Pemenuhan pesanan Pembayaran pesanan Penilaian risiko pesanan ditukar Kemas kini pesanan
Produk	Penciptaan produk Pemadaman produk Kemaskinian produk
Bayaran balik	Cipta bayaran balik
Shop	Kemas kini Shop
Tender	Penciptaan transaksi tender
Tema	Penciptaan tema Pemadaman tema Terbitkan tema Kemas kini tema
Transaksi	Penciptaan transaksi

Petua

Pembangun boleh merujuk senarai lengkap topik webhook semasa mencipta langganan webhook.

Cipta webhook

Anda boleh mencipta webhook pada bila-bila masa. Webhook anda ditandatangani dengan ID yang terdiri daripada gabungan huruf dan nombor yang unik untuk kedai anda.

Langkah-langkah:

Desktop

1. Daripada pentadbir Shopify anda, pergi ke Tetapan > Pemberitahuan.

2. Klik Webhook.

3. Klik ⊕ Cipta webhook.

4. Dalam menu juntai bawah Acara, pilih mana-mana acara webhook yang disokong yang ingin anda gunakan sebagai acara webhook anda. Anda tidak boleh menukar acara webhook selepas webhook dicipta.

5. Dalam menu juntai bawah Format, pilih format yang anda mahu Shopify menghantar maklumat ini kepada anda. Dua pilihan tersebut ialah JSON atau XML.

6. Dalam medan URL, masukkan URL tempat anda ingin data disimpan. Webhook tidak boleh dikembalikan ke URL berikut:

   • Localhost
   • Mana-mana URL yang berakhir dengan perkataan "internal" (seperti example.com/internal)
   • Mana-mana URL daripada sebarang domain tersuai yang dilampirkan pada kedai
   • Domain "Palsu" (seperti www.example.com)
   • Domain Shopify (seperti shopify.com dan myshopify.com)

7. Dalam Versi API Webhook, pilih versi webhook pilihan anda.

8. Klik Simpan.

Mudah alih

1. Daripada aplikasi Shopify, ketik , dan kemudian ketik Tetapan.

2. Dalam bahagian Tetapan kedai, ketik Pemberitahuan.

3. Ketik Webhook.

4. Ketik ⊕ Cipta webhook.

5. Dalam menu juntai bawah Acara, pilih mana-mana acara webhook yang disokong yang ingin anda gunakan sebagai acara webhook anda. Anda tidak boleh menukar acara webhook selepas webhook dicipta.

6. Dalam menu juntai bawah Format, pilih format yang anda mahu Shopify menghantar maklumat ini kepada anda. Dua pilihan tersebut ialah JSON atau XML.

7. Dalam medan URL, masukkan URL tempat anda ingin data disimpan. Webhook tidak boleh dikembalikan ke URL berikut:

   • Localhost
   • Mana-mana URL yang berakhir dengan perkataan "internal" (seperti example.com/internal)
   • Mana-mana URL daripada sebarang domain tersuai yang dilampirkan pada kedai
   • Domain "Palsu" (seperti www.example.com)
   • Domain Shopify (seperti shopify.com dan myshopify.com)

8. Dalam Versi API Webhook, pilih versi webhook pilihan anda.

9. Ketik Simpan atau ✓.

Selepas disimpan, webhook baharu anda dipaparkan pada halaman Webhook.

Sunting webhook

Anda boleh menyunting konfigurasi webhook selepas webhook dicipta. Walau bagaimanapun, anda tidak boleh mengubah suai acara webhook yang dipilih.

Langkah-langkah:

Desktop

1. Daripada pentadbir Shopify anda, pergi ke Tetapan > Pemberitahuan.

2. Klik Webhook.

3. Dalam baris yang mengandungi webhook yang ingin anda sunting, klik ... > Sunting.

4. Dalam dialog Sunting webhook, ubah suai webhook mengikut keperluan.

5. Klik Simpan.

Mudah alih

1. Daripada aplikasi Shopify, ketik , dan kemudian ketik Tetapan.

2. Dalam bahagian Tetapan kedai, ketik Pemberitahuan.

3. Ketik Webhook.

4. Dalam baris yang mengandungi webhook yang ingin anda sunting, ketik ... > Sunting.

5. Dalam dialog Sunting webhook, ubah suai webhook mengikut keperluan.

6. Ketik Simpan atau ✓.

Uji webhook

Anda boleh menguji webhook anda untuk memastikan maklumat acara yang anda mahukan dihantar ke URL yang betul.

Langkah-langkah:

Desktop

1. Daripada pentadbir Shopify anda, pergi ke Tetapan > Pemberitahuan.

2. Klik Webhook.

3. Dalam baris yang mengandungi webhook yang ingin anda uji, klik ... > Hantar ujian.

4. Pada URL yang anda tetapkan untuk webhook, sahkan bahawa pemberitahuan tersebut berfungsi.

Mudah alih

1. Daripada aplikasi Shopify, ketik , dan kemudian ketik Tetapan.

2. Dalam bahagian Tetapan kedai, ketik Pemberitahuan.

3. Ketik Webhook.

4. Dalam baris yang mengandungi webhook yang ingin anda uji, ketik ... > Hantar ujian.

5. Pada URL yang anda tetapkan untuk webhook, sahkan bahawa pemberitahuan tersebut berfungsi.

Padamkan webhook

Anda boleh memadamkan webhook dari pentadbir Shopify anda. Tindakan ini tidak boleh dibuat asal.

Nota

Jika destinasi webhook berulang kali mengembalikan respons status bukan 200, maka langganan webhook akan dipadamkan secara automatik daripada pentadbir Shopify anda.

Langkah-langkah:

Desktop

1. Daripada pentadbir Shopify anda, pergi ke Tetapan > Pemberitahuan.

2. Klik Webhook.

3. Dalam baris yang mengandungi webhook yang ingin anda padamkan, klik ... > Padam.

Mudah alih

1. Daripada aplikasi Shopify, ketik , dan kemudian ketik Tetapan.

2. Dalam bahagian Tetapan kedai, ketik Pemberitahuan.

3. Ketik Webhook.

4. Dalam baris yang mengandungi webhook yang ingin anda padamkan, ketik ... > Padam.