PaddleをShopify Flowに接続する方法

Paddleは、デジタル商品や定期購読の「マーチャント(決済代行業者)」です。取引、定期購読、返金、およびお客様情報の変更について通知を行います。「Workflow Webhooks」は、その通知を「Shopify Flow」のトリガーに変換するため、ストア側でそれに応じて対応することができます。具体的には、お客様へのタグ付け、注文メモの追加、社内メールの送信、メタフィールドの更新など、Shopify Flowで可能なあらゆる操作が可能です。

このガイドでは、Paddleが送信し、Workflow Webhooksが受信・検証し、Shopify Flowが処理を行うという一連の流れをすべて設定します。すべてのリクエストにおいてPaddleのHMAC署名が検証されるため、Paddle以外ではワークフローを開始することができません。

どのようなものを作れるか

  • 「Shopify」をご利用中で、かつ「Paddle」のサブスクリプションもご契約中のお客様をタグ付けしていただくと、その方に適切な価格やコンテンツが表示されます。
  • サブスクリプションが解約され、かつそのお客様が最近Shopifyで注文を行っている場合は、チームにメールをお送りください。
  • 現在のプランを、お客様レコードのメタフィールドとして登録してください。

送信する代表的なイベント:transaction.completed、subscription.canceled、adjustment.created(返金)、customer.updated。

始める前に

  • Workflow Webhooks Shopifyストアにインストールされています。
  • Shopify Flow インストール済みです。これは、ShopifyのApp Storeから無料で入手できます。
  • Webhookを作成する権限を持つPaddleのアカウントです。

ステップ 1 - Workflow Webhooks で Webhook を作成します

  1. Workflow Webhooks を開き**、[Webhook] → [Create Webhook]** の順に選択し、Shopify Flow で識別しやすい名前(例:Paddle events)を付けてください。
  2. **「認証」**で、「**HMAC」**を選択してください。
  3. 「署名プロバイダー」で「Paddle」を選択してください。アプリがヘッダー、アルゴリズム、署名付きペイロード、リプレイウィンドウを自動的に入力してくれます。これ以外に設定する必要はありません。
  4. 「シークレット」の欄はひとまず空のままにして、「保存」をクリックしてください。ページに表示されているWebhookのURLをコピーしてください。

その他の認証モードについては、認証 を、Shopify Flow に送信するフィールドの選択については、ペイロードのマッピングとShopify Flow変数 をご参照ください。

ステップ 2 - Paddle にエンドポイントを追加する

Paddleで、**「開発者ツール」→「通知」**を開き、コピーしたURLを宛先として追加し、イベントを選択してください。シークレットキーは、その宛先に表示されています。

Paddleの署名用シークレットを確認する方法

通知先の秘密鍵(Paddle → 開発者ツール → 通知)です。

Webhookの署名に関するPaddleの公式ドキュメント()には、お客様のアカウントに適用される正確な文言とスクリーンショットが掲載されています。

そのシークレットを、Workflow Webhooks の Webhook の**「Secret」**フィールドに貼り付けて、保存してください。それ以降、Paddle からのすべての配信は、Shopify Flow に届く前に検証されるようになります。

これが何をチェックするのか

何 値
署名ヘッダー Paddle-Signature
署名の位置 そのヘッダーのh1値には、セミコロンで区切られたkey=valueのペアが含まれています
何が署名されたのでしょうか {timestamp}:{body}
署名 HMAC-SHA256、16進数エンコード
タイムスタンプ 署名ヘッダーのts値(Unix秒単位)
リプレイ防止機能 署名付きタイムスタンプが現在から5分以上先であるリクエストは拒否されます
その秘密 プレーンテキストとして使用します。送信者が表示している通りに、そのまま貼り付けてください。

署名付きペイロードにおいて、{body} はバイト単位でリクエスト本文そのものであり、{timestamp} は上記のタイムスタンプです。

これらのいずれかの条件を満たさないリクエストは、401 のエラーで拒否され、沿革とトラブルシューティング に記録され、ワークフローは開始されません。

ステップ 3 - 「Shopify Flow」ワークフローを作成する

  1. Shopify Flow でワークフローを作成し、「Workflow Webhooks」トリガーを選択してください。
  2. 「**イベントの記録」**を押してから、Paddleからテストイベントを送信してください(または、Workflow Webhooksの「テスト送信」機能をご利用ください)。これにより、Shopify Flowがデータのパターンを学習します。
  3. 所有しているすべてのWebhookは同じShopify Flowトリガーを起動するため、このワークフローをPaddleのみに限定するために、Webhook IDを最初の条件として追加してください。IDはWebhookページに表示されています。
  4. アクションを追加してください ― お客様にタグを付けたり、メモを追加したり、社内メールを送信したり、メタフィールドを更新したりできます。
Shopify Flow
Shopify Flowで「トリガーを選択」を選択し、「Workflow Webhooks」を開き、「Webhookトリガー」を選択してください。
Shopify Flowの条件:Webhook IDが、あるWebhookのIDと一致すること
すべてのワークフローの最初のステップは、Webhook ID に基づく条件設定です。これにより、このワークフローは当該の Webhook に対してのみ実行されます。
完成したワークフロー:Webhookトリガー、Webhook IDに基づく条件、そして「True」分岐で内部メールを送信します
完成したワークフローは、トリガー、Webhook ID に基づく条件、そして「True」分岐でのアクションという流れになります。

ステップ4 - エンドツーエンドでテストする

Paddleで実際のイベントをトリガーしてください。**「Workflow Webhooks」→「History」**に、ステータスが「**Success」**の呼び出しが表示されるはずです。署名が正しくない場合は、その理由が記載された失敗のエントリが表示されます。また、署名付きWebhookの検証 には、どのステップで失敗したかを正確に示す署名テスターの説明が記載されています。

「History」に、リクエストヘッダー、ペイロード、ステータス、所要時間、および識別子を含む1つの呼び出しが開かれました
「History」でイベントが配信されました:ステータスが「Success」の場合、Shopify Flowがそれを受け入れたことを意味します。
署名が一致しません▾

順に、シークレット(最も一般的な原因は、余分なスペース、または間違った環境のキーです)、送信者が別のエンドポイントのシークレットを使用しているかどうか、そしてPaddleとアプリの間でボディが書き換えられていないかどうかです。署名は生のバイトを対象としているため、JSONのフォーマットを変更するプロキシによって署名が破損してしまいます。 Webhook ページの署名テスターには、署名された正確なテキストが表示されます。

どのリクエストでも401エラーが表示されます▾

Webhookの認証が**「HMAC」**に設定され、プロバイダーとして「Paddle」が選択されていること、シークレットが入力されていること、そしてPaddleが、アプリに表示されているURLとまったく同じ形式(末尾のコードを含む)で投稿を行っていることをご確認ください。

「履歴」には何も表示されません▾

リクエストは届きませんでした。PaddleでURLを再度確認し、Paddle自身の配信ログで受信したレスポンスをご確認ください。「404」というエラーは、Webhookの設定が間違っているか削除されていることを意味します。「429」というエラーは、ご利用のプランの呼び出し制限を超えていることを意味します。詳細は プランと利用方法 をご覧ください。

ワークフローが誤ったイベントに対して実行されてしまいます▾

ストア内のすべてのWebhookは、同じShopify Flowトリガーを起動します。ワークフローの最初のステップとして、Webhook IDに基づく条件を追加するか、Paddleから送信するイベントを絞り込んでください。

リクエストが「タイムスタンプが許容範囲外」というエラーで失敗します▾

Paddleはタイムスタンプを付加しており、アプリは5分以上経過したものはすべて拒否します。これは通常、送信側の時計の問題か、Paddleが元のタイムスタンプのままかなり遅れて再送信したケースです。同じ元のリクエストからの再送信は通過できませんので、Paddleに新しいイベントを送信するよう依頼してください。

関連情報