建立 Webhook

Webhook 是一種用於擷取並儲存特定事件資料的工具。您可以註冊一個 https:// 網址，以 JSON 或 XML 格式接收該事件的資料。Webhook 常見的用途如下：

建立訂單
變更商品價格
當您離線時，通知您的即時通訊用戶端或傳呼機
蒐集用於資料倉儲的資料
整合您的會計軟體
篩選訂單品項，並將訂單通知各家承運商
當顧客解除安裝您的 app 時，從資料庫移除顧客資料

本頁內容

支援的 Webhook 事件

在建立 Webhook 時，您可以從清單中的任何事件中選取。舉例來說，如果您想在每次訂單完成付款時傳送 Webhook，請選取 Order payment。再舉一例，如果您想在每次商店屬性更新時傳送 Webhook，請選取 Shop update。

此表列出 Shopify 管理介面支援的 Webhook 事件。
類別	事件
購物車	購物車建立購物車更新
結帳頁面	結帳頁面建立結帳頁面刪除結帳頁面更新
商品系列	商品系列建立商品系列刪除商品系列更新
顧客	顧客 SMS 行銷同意更新顧客帳號設定更新顧客建立顧客刪除顧客停用顧客電子郵件行銷同意更新顧客啟用顧客群組建立顧客群組刪除顧客群組更新新增顧客標籤移除顧客標籤顧客更新
折扣	折扣建立折扣刪除折扣更新
訂單草稿	訂單草稿建立訂單草稿刪除訂單草稿更新
出貨作業	出貨作業建立出貨服務無法完成出貨訂單出貨訂單的商品項目已備妥供取貨出貨訂單已移動出貨訂單已保留出貨訂單已重新排程已排程的出貨訂單到期出貨訂單的訂單路由已完成出貨訂單已取消出貨訂單取消要求已接受出貨訂單取消要求已拒絕出貨訂單取消要求已提交出貨訂單的要求出貨已接受出貨訂單的要求出貨已拒絕出貨訂單的要求出貨已提交出貨訂單保留已解除出貨訂單的商品項目已備妥進行當地配送出貨訂單已合併出貨訂單已拆分出貨作業更新
庫存	庫存商品建立庫存商品刪除庫存商品更新連結庫存量解除庫存量連結庫存量更新
地點	地點啟用地點建立地點停用地點刪除地點品項更新
市場	市場建立市場刪除市場更新
訂單	訂單取消訂單建立訂單刪除訂單編輯訂單出貨作業訂單付款訂單風險評估變更訂單更新
商品	商品建立商品刪除商品更新
退款	退款建立
商店	商店更新
付款方式	付款交易建立
佈景主題	佈景主題建立佈景主題刪除佈景主題發布佈景主題更新
交易	交易建立

建立 Webhook

您可隨時建立 Webhook。系統會以專屬於您商店、由英數字組成的 ID 簽署這些 Webhook。

步驟：

電腦版

在 Shopify 管理介面，前往設定 > 通知。
按一下 Webhook。
按一下 ⊕ 建立 Webhook。
在事件下拉式選單中，選取您要使用的任一支援的 Webhook 事件。建立 Webhook 後，無法變更事件。
在格式下拉式選單中，選擇要由 Shopify 傳送資訊給您的格式。可選擇 JSON 或 XML 兩種格式。
在網址欄位，輸入您要接收資料的網址。Webhook 無法傳送至以下網址：
- localhost
- 任何以「internal」結尾的網址 (例如 example.com/internal)
- 任何來自已連結至商店的自訂網域的網址
- 「假」網域 (例如 www.example.com)
- Shopify 網域 (例如 shopify.com 與 myshopify.com)
在 Webhook API 版本 中，選取您偏好的 Webhook 版本。
按一下儲存。

行動版

在 Shopify app 中，點選，然後點選設定。
在 商店設定 區段，點選通知。
點選 Webhook。
點選 ⊕ 建立 Webhook。
在事件下拉式選單中，選取您要使用的任一支援的 Webhook 事件。建立 Webhook 後，無法變更事件。
在格式下拉式選單中，選擇要由 Shopify 傳送資訊給您的格式。可選擇 JSON 或 XML 兩種格式。
在網址欄位，輸入您要接收資料的網址。Webhook 無法傳送至以下網址：
- localhost
- 任何以「internal」結尾的網址 (例如 example.com/internal)
- 任何來自已連結至商店的自訂網域的網址
- 「假」網域 (例如 www.example.com)
- Shopify 網域 (例如 shopify.com 與 myshopify.com)
在 Webhook API 版本 中，選取您偏好的 Webhook 版本。
點選儲存或 ✓。

儲存新的 Webhook 後，系統會在 Webhook 頁面顯示。

編輯 Webhook

建立後可編輯 Webhook 的設定，但無法變更所選的 Webhook 事件。

步驟：

電腦版

在 Shopify 管理介面，前往設定 > 通知。
按一下 Webhook。
在您要編輯的 Webhook 所在列，按一下 ... > 編輯。
在 編輯 Webhook 對話方塊中，依需要修改 Webhook。
按一下儲存。

行動版

在 Shopify app 中，點選，然後點選設定。
在 商店設定 區段，點選通知。
點選 Webhook。
在您要編輯的 Webhook 所在列，點選 ... > 編輯。
在 編輯 Webhook 對話方塊中，依需要修改 Webhook。
點選儲存或 ✓。

測試 Webhook

您可以測試 Webhook，確認所需的事件資訊已傳送至正確的網址。

步驟：

電腦版

在 Shopify 管理介面，前往設定 > 通知。
按一下 Webhook。
在您要測試的 Webhook 所在列，按一下 ... > 傳送測試。
在您為該 Webhook 指定的網址，確認通知是否正常運作。

行動版

在 Shopify app 中，點選，然後點選設定。
在 商店設定 區段，點選通知。
點選 Webhook。
在您要測試的 Webhook 所在列，點選 ... > 傳送測試。
在您為該 Webhook 指定的網址，確認通知是否正常運作。

刪除 Webhook

您可以在 Shopify 管理介面刪除 Webhook。此動作無法復原。

步驟：

電腦版

在 Shopify 管理介面，前往設定 > 通知。
按一下 Webhook。
在您要刪除的 Webhook 所在列，按一下 ... > 刪除。

行動版

在 Shopify app 中，點選，然後點選設定。
在 商店設定 區段，點選通知。
點選 Webhook。
在您要刪除的 Webhook 所在列，點選 ... > 刪除。