Webhookの作成

Webhookは、特定のイベントのデータを取得して保存するためのツールです。イベントデータを JSONまたは XML形式で保存できる https:// の URLを登録できます。Webhookは一般的に、以下のような理由で使用されます。

• 注文の作成
• 商品の価格変更
• オフラインの際のIM クライアントやポケットベルへの通知
• データウェアハウジングのためのデータ収集
• 会計ソフトウェアとの連携
• 注文アイテムの絞り込みと、さまざまな配送業者への注文通知
• お客様がアプリをアンインストールした際の、データベースからのお客様データの削除

注

Webhook が失敗すると、ストアオーナーのメールアドレスにメールが届きます。このメールは、Webhook が Shopify App Store のアプリまたは カスタムアプリ によって作成された場合にのみ送信されます。Webhook の送信先が 200 以外のステータスレスポンスを繰り返し返す場合、Webhookサブスクリプションは管理画面から自動的に削除されます。

ヒント

Webhook の問題に関する高度なトラブルシューティングについて、開発者の方は開発者ドキュメントのTroubleshooting webhooks ガイドを参照できます。

サポートされているWebhookイベント

Webhookを作成する際に、一覧にあるいずれかのイベントを選択できます。たとえば、注文の支払いがあるたびに送信されるWebhookを作成する場合は、[注文の支払い] を選択します。別の例として、shopプロパティが更新されるたびに送信されるWebhookを作成する場合は、[Shopの更新] を選択します。

管理画面で利用できる、サポートされているWebhookイベントを一覧にした表。

カテゴリー	イベント
カート	カートの作成 カートの更新
チェックアウト	チェックアウトの作成 チェックアウトの削除 チェックアウトの更新
コレクション	コレクションの作成 コレクションの削除 コレクションの更新
お客様	お客様のSMSマーケティングに関する同意の更新 お客様アカウント設定の更新 お客様の作成 お客様の削除 お客様の無効化 お客様のメールマーケティングに関する同意の更新 お客様の有効化 お客様グループの作成 お客様グループの削除 お客様グループの更新 お客様のタグ追加 お客様のタグ削除 お客様の更新
ディスカウント	ディスカウントの作成 ディスカウントの削除 ディスカウントの更新
下書き注文	下書き注文の作成 下書き注文の削除 下書き注文の更新
フルフィルメント	フルフィルメントの作成 フルフィルメントサービスによるフルフィルメント注文の完了不可 フルフィルメント注文項目の受取準備完了 フルフィルメント注文の移動 フルフィルメント注文の保留 フルフィルメント注文の再スケジュール スケジュールされていたフルフィルメント注文の期日到来 フルフィルメント注文の注文ルーティング完了 フルフィルメント注文のキャンセル フルフィルメント注文のキャンセルリクエストの承認 フルフィルメント注文のキャンセルリクエストの拒否 フルフィルメント注文のキャンセルリクエストの送信 フルフィルメント注文のフルフィルメントリクエストの承認 フルフィルメント注文のフルフィルメントリクエストの拒否 フルフィルメント注文のフルフィルメントリクエストの送信 フルフィルメント注文の保留解除 フルフィルメント注文項目のローカルデリバリー準備完了 フルフィルメント注文のマージ フルフィルメント注文の分割 フルフィルメントの更新
在庫	在庫アイテムの作成 在庫アイテムの削除 在庫アイテムの更新 在庫レベルの接続 在庫レベルの切断 在庫レベルの更新
ロケーション	ロケーションの有効化 ロケーションの作成 ロケーションの無効化 ロケーションの削除 ロケーションアイテムの更新
マーケット	マーケットの作成 マーケットの削除 マーケットの更新
注文	注文のキャンセル 注文の作成 注文の削除 注文の編集 注文のフルフィルメント 注文の決済 注文のリスク評価の変更 注文の更新
商品	商品の作成 商品の削除 商品の更新
返金	返金の作成
Shop	Shop の更新
支払い取引	支払い取引の作成
テーマ	テーマの作成 テーマの削除 テーマの公開 テーマの更新
取引	取引の作成

ヒント

開発者の方は、Webhook サブスクリプションを作成する際に、Webhook トピックの完全なリストを参照できます。

Webhook の作成

Webhook はいつでも作成できます。Webhook は、ストアに固有の文字と数字を組み合わせた ID を使って署名されます。

手順：

デスクトップ

1. 管理画面から、[設定] > [通知] に移動します。

2. [Webhook] をクリックします。

3. [⊕ Webhook を作成] をクリックします。

4. [イベント] ドロップダウンメニューで、Webhook イベントとして使用するサポート対象の Webhook イベントをいずれか選択します。Webhook を作成した後は、Webhook イベントを変更することはできません。

5. [フォーマット] ドロップダウンメニューで、Shopify からこの情報を送信する際のフォーマットを選択します。JSON または XML の 2 種類から選択できます。

6. [URL] フィールドに、データを保存する URL を入力します。以下の URL には、Webhook を送信することはできません。

   • Localhost
   • 「internal」という単語で終わる URL (例：example.com/internal)
   • ストアに追加されているカスタムドメインの URL
   • 架空のドメイン (例：www.example.com)
   • Shopify ドメイン (例：shopify.com、myshopify.com)

7. [Webhook API バージョン] で、希望する Webhook のバージョンを選択します。

8. [保存] をクリックします。

モバイル

1. Shopify app から をタップし、 設定をタップします。

2. [ストアの設定] セクションで、[通知] をタップします。

3. [Webhook] をタップします。

4. [⊕ Webhook を作成] をタップします。

5. [イベント] ドロップダウンメニューで、Webhook イベントとして使用するサポート対象の Webhook イベントをいずれか選択します。Webhook を作成した後は、Webhook イベントを変更することはできません。

6. [フォーマット] ドロップダウンメニューで、Shopify からこの情報を送信する際のフォーマットを選択します。JSON または XML の 2 種類から選択できます。

7. [URL] フィールドに、データを保存する URL を入力します。以下の URL には、Webhook を送信することはできません。

   • Localhost
   • 「internal」という単語で終わる URL (例：example.com/internal)
   • ストアに追加されているカスタムドメインの URL
   • 架空のドメイン (例：www.example.com)
   • Shopify ドメイン (例：shopify.com、myshopify.com)

8. [Webhook API バージョン] で、希望する Webhook のバージョンを選択します。

9. [保存] または [✓] をタップします。

新しい Webhook を保存すると、その Webhook は [Webhook] ページに表示されます。

Webhook の編集

Webhook は、作成後に設定を編集できます。ただし、選択した Webhook イベントは変更できません。

手順：

デスクトップ

1. 管理画面から、[設定] > [通知] に移動します。

2. [Webhook] をクリックします。

3. 編集する Webhook がある行で、[...] > [編集] をクリックします。

4. [Webhook を編集] ダイアログで、必要に応じて Webhook を変更します。

5. [保存] をクリックします。

モバイル

1. Shopify app から をタップし、 設定をタップします。

2. [ストアの設定] セクションで、[通知] をタップします。

3. [Webhook] をタップします。

4. 編集する Webhook がある行で、[...] > [編集] をタップします。

5. [Webhook を編集] ダイアログで、必要に応じて Webhook を変更します。

6. [保存] または [✓] をタップします。

Webhook のテスト

Webhook をテストして、目的のイベント情報が正しい URL に送信されていることを確認できます。

手順：

デスクトップ

1. 管理画面から、[設定] > [通知] に移動します。

2. [Webhook] をクリックします。

3. テストする Webhook がある行で、[...] > [テストを送信] をクリックします。

4. Webhook に指定した URL で、通知が機能することを確認します。

モバイル

1. Shopify app から をタップし、 設定をタップします。

2. [ストアの設定] セクションで、[通知] をタップします。

3. [Webhook] をタップします。

4. テストする Webhook がある行で、[...] > [テストを送信] をタップします。

5. Webhook に指定した URL で、通知が機能することを確認します。

Webhook の削除

管理画面から Webhook を削除できます。この操作を元に戻すことはできません。

注

Webhook の送信先が、ステータス 200 以外のレスポンスを繰り返し返す場合、その Webhook サブスクリプションは管理画面から自動的に削除されます。

手順：

デスクトップ

1. 管理画面から、[設定] > [通知] に移動します。

2. [Webhook] をクリックします。

3. 削除する Webhook がある行で、[...] > [削除] をクリックします。

モバイル

1. Shopify app から をタップし、 設定をタップします。

2. [ストアの設定] セクションで、[通知] をタップします。

3. [Webhook] をタップします。

4. 削除する Webhook がある行で、[...] > [削除] をタップします。