Webhookを作成する
Webhookは、特定のイベントからデータを取得して格納するためのツールです。イベントデータをJSON形式またはXML形式で保存できるhttps://
URLを登録できます。Webhookは、一般的に以下の理由で使用されます。
- 注文する
- 商品の価格を変更する
- オフライン時にIMクライアントまたはページャーに通知する
- データウェアハウジングのデータを収集する
- 会計ソフトウェアを統合する
- 注文アイテムをフィルタリングし、注文についてさまざまな配送者に情報を通知する
- お客様がアプリをアンインストールするときに、データベースからお客様のデータを削除する
対応済みのWebhookイベント
Webhookを作成する場合、一覧表示されているイベントから選択できます。たとえば、注文の支払いが行われるごとに送信されるWebhookを作成する場合、[注文の支払い] を選択します。別の例として、ショップのプロパティが更新されるごとに送信されるWebhookを作成する場合は、[ショップの更新] を選択します。
カテゴリー | イベント |
---|---|
カート |
|
チェックアウト |
|
コレクション |
|
お客様 |
|
割引 |
|
下書き注文 |
|
フルフィルメント |
|
在庫 |
|
Location |
|
マーケット |
|
注文する |
|
商品 |
|
返金 |
|
ショップ |
|
支払い方法 |
|
テーマ |
|
取引 |
|
Webhookを作成する
いつでもWebhookを作成できます。Webhookは、ストア固有の文字と数字の組み合わせで構成されるIDで署名されます。
手順
デスクトップ
管理画面から、[設定] > [通知] に移動します。
[Webhook] をクリックします。
[⊕Webhookを作成] をクリックします。
[イベント] ドロップダウンメニューで、Webhookイベントとして使用する対応済みのWebhookイベントを選択します。Webhookを作成した後でWebhookイベントを変更することはできません。
[フォーマット] ドロップダウンメニューで、Shopifyがこの情報を送信する際に使用するフォーマットを選択します。JSONとXMLの2つの選択肢があります。
[URL] フィールドに、データを保存するURLを入力します。以下のURLにはWebhookを返すことができません。
- Localhost
- 「internal」という単語で終わるURL (
example.com/internal
など) - ストアと連携しているカスタムドメインのURL
- 「虚偽」のドメイン (
www.example.com
など) - Shopifyドメイン (
shopify.com
やmyshopify.com
など)
Webhook APIのバージョンで、希望するWebhookバージョンを選択します。
[保存] をクリックします。
iPhone
Shopifyアプリから、
> [設定] の順にタップします。
[ストアの設定] セクションで、[通知] をタップします。
[Webhook] をタップします。
[⊕Webhookを作成] をタップします。
[イベント] ドロップダウンメニューで、Webhookイベントとして使用する対応済みのWebhookイベントを選択します。Webhookを作成した後でWebhookイベントを変更することはできません。
[フォーマット] ドロップダウンメニューで、Shopifyがこの情報を送信する際に使用するフォーマットを選択します。JSONとXMLの2つの選択肢があります。
[URL] フィールドに、データを保存するURLを入力します。以下のURLにはWebhookを返すことができません。
- Localhost
- 「internal」という単語で終わるURL (
example.com/internal
など) - ストアと連携しているカスタムドメインのURL
- 「虚偽」のドメイン (
www.example.com
など) - Shopifyドメイン (
shopify.com
やmyshopify.com
など)
Webhook APIのバージョンで、希望するWebhookバージョンを選択します。
[保存] をタップします。
Android
- Shopifyアプリから、
> [設定] の順にタップします。
- [ストア設定] セクションで、[通知] をタップします。3. [Webhook] をタップします。4. [⊕Webhookを作成] をタップします。5. [イベント] ドロップダウンメニューで、Webhookイベントとして使用する対応済みのWebhookイベントを選択します。Webhookを作成した後は、Webhookイベントを変更することはできません。6. [フォーマット] ドロップダウンメニューで、Shopifyがこの情報を送信する際に使用するフォーマットを選択します。選択肢はJSONまたはXMLの2つです。7. URLフィールドに、データを保存するURLを入力します。Webhookは次のURLには返せません:* 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] をクリックします。
編集するWebhookが含まれる行で、[...] > [編集] をクリックします。
[Webhookを編集] ダイアログで、必要に応じてWebhookを変更します。
[保存] をクリックします。
iPhone
Shopifyアプリから、
> [設定] の順にタップします。
[ストアの設定] セクションで、[通知] をタップします。
[Webhook] をタップします。
編集するWebhookが含まれる行で、[...] > [編集] をタップします。
[Webhookを編集] ダイアログで、必要に応じてWebhookを変更します。
[保存] をタップします。
Android
- Shopifyアプリから、
> [設定] の順にタップします。
- [ストアの設定] セクションで、[通知] をタップします。3. [Webhooks] をタップします。4. 編集するWebhookが含まれる行で、[...] > [編集] をタップします。 5. [Webhookを編集] ダイアログで、必要に応じてWebhookを変更します。6. [✓] をタップします。
Webhookをテストする
Webhookをテストして、必要なイベント情報が正しいURLに送信されていることを確認できます。
手順
デスクトップ
管理画面から、[設定] > [通知] に移動します。
[Webhook] をクリックします。
テストするWebhookが含まれる行で、[...] > [テストを送信] をクリックします。
Webhookに指定したURLで、通知が機能することを確認します。
iPhone
Shopifyアプリから、
> [設定] の順にタップします。
[ストアの設定] セクションで、[通知] をタップします。
[Webhook] をタップします。
テストするWebhookが含まれる行で、[...] > [テストを送信] をタップします。
Webhookに指定したURLで、通知が機能することを確認します。
Android
- Shopifyアプリから、
> [設定] の順にタップします。
- [ストアの設定] セクションで、[通知] をタップします。3. [Webhooks] をタップします。4. テストするWebhookが含まれる行で、[...] > [テストを送信] をタップします。5. Webhookに指定したURLで、通知が機能することを確認します。
Webhookを削除する
管理画面でWebhookを削除できます。この操作を元に戻すことはできません。
手順
デスクトップ
管理画面から、[設定] > [通知] に移動します。
[Webhook] をクリックします。
削除するWebhookが含まれる行で、[...] > [削除] をクリックします。
iPhone
Shopifyアプリから、
> [設定] の順にタップします。
[ストアの設定] セクションで、[通知] をタップします。
[Webhook] をタップします。
削除するWebhookが含まれる行で、[...] > [削除] をタップします。
Android
- Shopifyアプリから、
> [設定] の順にタップします。
- [ストアの設定] セクションで、[通知] をタップします。3. [Webhooks] をタップします。4. 削除するWebhookが含まれる行で、[...] > [削除] をタップします。