Membuat webhook
Webhook adalah alat untuk mengambil dan menyimpan data dari peristiwa tertentu. Webhook memungkinkan Anda mendaftarkan URL https:// tempat data peristiwa dapat disimpan dalam format JSON atau XML. Webhook biasanya digunakan untuk alasan berikut:
- Membuat pesanan
- Mengubah harga produk
- Memberi tahu klien IM atau pager Anda saat Anda sedang offline
- Mengumpulkan data untuk pergudangan data
- Mengintegrasikan perangkat lunak akuntansi Anda
- Memfilter item pesanan dan menginformasikan berbagai pengirim tentang pesanan tersebut
- Menghapus data pelanggan dari database Anda saat mereka menghapus instalasi aplikasi Anda
Di halaman ini
Peristiwa webhook yang didukung
Saat membuat webhook, Anda dapat memilih dari setiap peristiwa yang tercantum. Misalnya, jika Anda ingin membuat webhook yang dikirim setiap kali pesanan dibayar, pilih Pembayaran pesanan. Contoh lainnya, jika Anda ingin membuat webhook yang dikirim setiap kali properti toko diperbarui, pilih Pembaruan toko.
| Kategori | Peristiwa |
|---|---|
| Keranjang |
|
| Checkout |
|
| Koleksi |
|
| Pelanggan |
|
| Diskon |
|
| Draf pesanan |
|
| Pemenuhan |
|
| Inventaris |
|
| Lokasi |
|
| Pasar |
|
| Pesanan |
|
| Produk |
|
| Pengembalian dana |
|
| Shop |
|
| Pembayaran |
|
| Tema |
|
| Transaksi |
|
Buat webhook
Anda dapat membuat webhook kapan saja. Webhook Anda ditandatangani dengan ID yang terdiri dari kombinasi huruf dan angka yang unik untuk toko Anda.
Langkah-langkah:
Desktop
Dari admin Shopify Anda, buka Pengaturan > Notifikasi.
Klik Webhook.
Klik ⊕ Buat webhook.
Di menu tarik-turun Event, pilih salah satu event webhook yang didukung yang ingin Anda gunakan sebagai event webhook Anda. Anda tidak dapat mengubah event webhook setelah webhook dibuat.
Di menu tarik-turun Format, pilih format yang Anda inginkan untuk Shopify mengirimkan informasi ini kepada Anda. Dua pilihannya adalah JSON atau XML.
Di kolom URL, masukkan URL tempat Anda ingin menyimpan data. Webhook tidak dapat dikembalikan ke URL berikut:
- Localhost
- URL apa pun yang diakhiri dengan kata "internal" (seperti
example.com/internal) - URL apa pun dari domain kustom yang terhubung ke toko
- Domain "palsu" (seperti
www.example.com) - Domain Shopify (seperti
shopify.comdanmyshopify.com)
Di Versi API webhook, pilih versi webhook pilihan Anda.
Klik Simpan.
Seluler
Dari aplikasi Shopify, ketuk
, lalu ketuk
Pengaturan.
Di bagian Pengaturan toko, ketuk Notifikasi.
Ketuk Webhook.
Ketuk ⊕ Buat webhook.
Di menu tarik-turun Event, pilih salah satu event webhook yang didukung yang ingin Anda gunakan sebagai event webhook Anda. Anda tidak dapat mengubah event webhook setelah webhook dibuat.
Di menu tarik-turun Format, pilih format yang Anda inginkan untuk Shopify mengirimkan informasi ini kepada Anda. Dua pilihannya adalah JSON atau XML.
Di kolom URL, masukkan URL tempat Anda ingin menyimpan data. Webhook tidak dapat dikembalikan ke URL berikut:
- Localhost
- URL apa pun yang diakhiri dengan kata "internal" (seperti
example.com/internal) - URL apa pun dari domain kustom yang terhubung ke toko
- Domain "palsu" (seperti
www.example.com) - Domain Shopify (seperti
shopify.comdanmyshopify.com)
Di Versi API webhook, pilih versi webhook pilihan Anda.
Ketuk Simpan atau ✓.
Setelah webhook baru Anda disimpan, webhook tersebut akan ditampilkan di halaman Webhook.
Edit webhook
Anda dapat mengedit konfigurasi webhook setelah dibuat. Namun, Anda tidak dapat mengubah event webhook yang dipilih.
Langkah-langkah:
Desktop
Dari admin Shopify Anda, buka Pengaturan > Notifikasi.
Klik Webhook.
Di baris yang berisi webhook yang ingin diedit, klik ... > Edit.
Di dialog Edit webhook, ubah webhook sesuai kebutuhan.
Klik Simpan.
Seluler
Dari aplikasi Shopify, ketuk
, lalu ketuk
Pengaturan.
Di bagian Pengaturan toko, ketuk Notifikasi.
Ketuk Webhook.
Di baris yang berisi webhook yang ingin diedit, ketuk ... > Edit.
Di dialog Edit webhook, ubah webhook sesuai kebutuhan.
Ketuk Simpan atau ✓.
Uji webhook
Anda dapat menguji webhook untuk memastikan informasi event yang Anda inginkan dikirim ke URL yang benar.
Langkah-langkah:
Desktop
Dari admin Shopify Anda, buka Pengaturan > Notifikasi.
Klik Webhook.
Di baris yang berisi webhook yang ingin diuji, klik ... > Kirim pengujian.
Di URL yang Anda tentukan untuk webhook, verifikasi bahwa notifikasi berfungsi.
Seluler
Dari aplikasi Shopify, ketuk
, lalu ketuk
Pengaturan.
Di bagian Pengaturan toko, ketuk Notifikasi.
Ketuk Webhook.
Di baris yang berisi webhook yang ingin diuji, ketuk ... > Kirim pengujian.
Di URL yang Anda tentukan untuk webhook, verifikasi bahwa notifikasi berfungsi.
Hapus webhook
Anda dapat menghapus webhook dari admin Shopify Anda. Tindakan ini tidak dapat dibatalkan.
Langkah-langkah:
Desktop
Dari admin Shopify Anda, buka Pengaturan > Notifikasi.
Klik Webhook.
Di baris yang berisi webhook yang ingin dihapus, klik ... > Hapus.
Seluler
Dari aplikasi Shopify, ketuk
, lalu ketuk
Pengaturan.
Di bagian Pengaturan toko, ketuk Notifikasi.
Ketuk Webhook.
Di baris yang berisi webhook yang ingin dihapus, ketuk ... > Hapus.