建立 Webhook

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

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

支援的 Webhook 事件

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

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

建立 Webhook

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

步驟:

電腦版
  1. 在 Shopify 管理介面,前往 設定 > 通知

  2. 按一下 Webhook

  3. 按一下 ⊕ 建立 Webhook

  4. 事件 下拉式選單中,選取您要使用的任一 支援的 Webhook 事件。建立 Webhook 後,無法變更事件。

  5. 格式 下拉式選單中,選擇要由 Shopify 傳送資訊給您的格式。可選擇 JSON 或 XML 兩種格式。

  6. 網址 欄位,輸入您要接收資料的網址。Webhook 無法傳送至以下網址:

    • localhost
    • 任何以「internal」結尾的網址 (例如 example.com/internal)
    • 任何來自已連結至商店的自訂網域的網址
    • 「假」網域 (例如 www.example.com)
    • Shopify 網域 (例如 shopify.commyshopify.com)
  7. Webhook API 版本 中,選取您偏好的 Webhook 版本。

  8. 按一下 儲存

行動版
  1. Shopify app 中,點選 Menu,然後點選 Settings **設定**。

  2. 商店設定 區段,點選 通知

  3. 點選 Webhook

  4. 點選 ⊕ 建立 Webhook

  5. 事件 下拉式選單中,選取您要使用的任一 支援的 Webhook 事件。建立 Webhook 後,無法變更事件。

  6. 格式 下拉式選單中,選擇要由 Shopify 傳送資訊給您的格式。可選擇 JSON 或 XML 兩種格式。

  7. 網址 欄位,輸入您要接收資料的網址。Webhook 無法傳送至以下網址:

    • localhost
    • 任何以「internal」結尾的網址 (例如 example.com/internal)
    • 任何來自已連結至商店的自訂網域的網址
    • 「假」網域 (例如 www.example.com)
    • Shopify 網域 (例如 shopify.commyshopify.com)
  8. Webhook API 版本 中,選取您偏好的 Webhook 版本。

  9. 點選 儲存

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

編輯 Webhook

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

步驟:

電腦版
  1. 在 Shopify 管理介面,前往 設定 > 通知

  2. 按一下 Webhook

  3. 在您要編輯的 Webhook 所在列,按一下 ... > 編輯

  4. 編輯 Webhook 對話方塊中,依需要修改 Webhook。

  5. 按一下 儲存

行動版
  1. Shopify app 中,點選 Menu,然後點選 Settings **設定**。

  2. 商店設定 區段,點選 通知

  3. 點選 Webhook

  4. 在您要編輯的 Webhook 所在列,點選 ... > 編輯

  5. 編輯 Webhook 對話方塊中,依需要修改 Webhook。

  6. 點選 儲存

測試 Webhook

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

步驟:

電腦版
  1. 在 Shopify 管理介面,前往 設定 > 通知

  2. 按一下 Webhook

  3. 在您要測試的 Webhook 所在列,按一下 ... > 傳送測試

  4. 在您為該 Webhook 指定的網址,確認通知是否正常運作。

行動版
  1. Shopify app 中,點選 Menu,然後點選 Settings **設定**。

  2. 商店設定 區段,點選 通知

  3. 點選 Webhook

  4. 在您要測試的 Webhook 所在列,點選 ... > 傳送測試

  5. 在您為該 Webhook 指定的網址,確認通知是否正常運作。

刪除 Webhook

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

步驟:

電腦版
  1. 在 Shopify 管理介面,前往 設定 > 通知

  2. 按一下 Webhook

  3. 在您要刪除的 Webhook 所在列,按一下 ... > 刪除

行動版
  1. Shopify app 中,點選 Menu,然後點選 Settings **設定**。

  2. 商店設定 區段,點選 通知

  3. 點選 Webhook

  4. 在您要刪除的 Webhook 所在列,點選 ... > 刪除