Webhookを作成する

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

• 注文する
• 商品の価格を変更する
• オフライン時にIMクライアントまたはページャーに通知する
• データウェアハウジングのデータを収集する
• 会計ソフトウェアを統合する
• 注文アイテムをフィルタリングし、注文についてさまざまな配送者に情報を通知する
• お客様がアプリをアンインストールするときに、データベースからお客様のデータを削除する

メモ

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

対応済みのWebhookイベント

Webhookを作成する場合、一覧表示されているイベントから選択できます。たとえば、注文の支払いが行われるごとに送信されるWebhookを作成する場合、[注文の支払い] を選択します。別の例として、ショップのプロパティが更新されるごとに送信されるWebhookを作成する場合は、[ショップの更新] を選択します。

管理画面で利用可能な対応済みのWebhookイベントの一覧表。

カテゴリー	イベント
カート	カートの作成 カートの更新
チェックアウト	チェックアウトの作成 チェックアウトの削除 チェックアウトの更新
コレクション	コレクションの作成 コレクションの削除 コレクションの更新
お客様	お客様によるSMSマーケティングに関する同意の更新 お客様アカウント設定の更新 お客様の作成 お客様の削除 お客様の無効化 お客様によるメールマーケティングに関する同意の更新 お客様の有効化 お客様グループの作成 お客様グループの削除 お客様グループの更新 お客様タグが追加されました お客様タグが削除されました お客様の更新
割引	ディスカウントの作成 ディスカウントの削除 ディスカウントの更新
下書き注文	下書き注文の作成 下書き注文の削除 下書き注文の更新
フルフィルメント	フルフィルメントの作成 フルフィルメントサービスではフルフィルメント注文を完了することはできません フルフィルメント注文の項目の受取準備が整ったとき フルフィルメント注文が移動したとき フルフィルメント注文が保留になりました フルフィルメント注文が再スケジュールされました スケジュール設定されていたフルフィルメント注文が期限になる フルフィルメント注文の注文ルーティングが完了しました フルフィルメント注文がキャンセルされました フルフィルメント注文のキャンセルリクエストが承認されました フルフィルメント注文のキャンセルリクエストが拒否されました フルフィルメント注文のキャンセルリクエストが送信されました フルフィルメント注文のフルフィルメントリクエストが承認されました フルフィルメント注文のフルフィルメントリクエストが拒否されました フルフィルメント注文のフルフィルメントリクエストが送信されました フルフィルメント注文の保留が解除されました ローカルデリバリー用に準備されたフルフィルメント注文の項目 フルフィルメント注文が統合されました フルフィルメント注文が分割されました フルフィルメントの更新
在庫	在庫アイテムの作成 在庫アイテムの削除 在庫アイテムの更新 在庫レベルの連携 在庫レベルの連携解除 在庫レベルの更新
Location	ロケーションの有効化 ロケーションの作成 ロケーションの無効化 ロケーションの削除 ロケーションアイテムの更新
マーケット	マーケットの作成 マーケットの削除 マーケットの更新
注文する	注文のキャンセル 注文作成 注文の削除 注文の編集 注文フルフィルメント 注文の支払い 注文リスク評価が変更されました 注文の更新
商品	商品作成 商品の削除 商品の更新
返金	返金の作成
ショップ	ショップの更新
支払い方法	支払い取引の作成
テーマ	テーマの作成 テーマの削除 テーマの公開 テーマの更新
取引	取引の作成

ヒント

開発者は、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. [保存] をクリックします。

iPhone

1. Shopifyアプリで [...] ボタンをタップして、[設定] をタップします。
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. [保存] をタップします。

Android

1. Shopifyアプリで [☰] ボタンをタップし、[設定] をタップします。
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イベントを変更することはできません。

手順

デスクトップ

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

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

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

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

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

iPhone

1. Shopifyアプリで [...] ボタンをタップして、[設定] をタップします。
2. [ストアの設定] セクションで、[通知] をタップします。
3. [Webhook] をタップします。
4. 編集するWebhookが含まれる行で、[...] > [編集] をタップします。
5. [Webhookを編集] ダイアログで、必要に応じてWebhookを変更します。
6. [保存] をタップします。

Android

1. Shopifyアプリで [☰] ボタンをタップし、[設定] をタップします。
2. [ストアの設定] セクションで、[通知] をタップします。
3. [Webhook] をタップします。
4. 編集するWebhookが含まれる行で、[...] > [編集] をタップします。
5. [Webhookを編集] ダイアログで、必要に応じてWebhookを変更します。
6. [✓] をタップします。

Webhookをテストする

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

手順

デスクトップ

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

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

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

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

iPhone

1. Shopifyアプリで [...] ボタンをタップして、[設定] をタップします。
2. [ストアの設定] セクションで、[通知] をタップします。
3. [Webhook] をタップします。
4. テストするWebhookが含まれる行で、[...] > [テストを送信] をタップします。
5. Webhookに指定したURLで、通知が機能することを確認します。

Android

1. Shopifyアプリで [☰] ボタンをタップし、[設定] をタップします。
2. [ストアの設定] セクションで、[通知] をタップします。
3. [Webhook] をタップします。
4. テストするWebhookが含まれる行で、[...] > [テストを送信] をタップします。
5. Webhookに指定したURLで、通知が機能することを確認します。

Webhookを削除する

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

メモ

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

手順

デスクトップ

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

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

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

iPhone

1. Shopifyアプリで [...] ボタンをタップして、[設定] をタップします。
2. [ストアの設定] セクションで、[通知] をタップします。
3. [Webhook] をタップします。
4. 削除するWebhookが含まれる行で、[...] > [削除] をタップします。

Android

1. Shopifyアプリで [☰] ボタンをタップし、[設定] をタップします。
2. [ストアの設定] セクションで、[通知] をタップします。
3. [Webhook] をタップします。
4. 削除するWebhookが含まれる行で、[...] > [削除] をタップします。