PaystackをShopify Flowに連携する方法

Paystackは、アフリカ全土で広く利用されている決済プラットフォームです。このプラットフォームでは、請求、送金、定期購入、返金に関する通知が届きます。「Workflow Webhooks」は、その通知をShopify Flowのトリガーに変換するため、ストア側でそれに応じて対応することができます。具体的には、顧客へのタグ付け、注文メモの追加、内部メールの送信、メタフィールドの更新など、Shopify Flowで可能なあらゆる操作を行うことが可能です。

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

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

  • Paystackのチェックアウトを通じてお支払いいただいたShopifyのお客様にタグを付けてください。
  • 返金が完了したら、注文メモを追加してください。
  • 定期購読の定期請求が失敗した場合は、担当者にメールをお送りください。

送信される代表的なイベントは以下の通りです:charge.success、transfer.success、subscription.disable、refund.processed。

始める前に

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

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

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

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

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

Paystackダッシュボードで、**「設定」→「APIキーとWebhook」**を開き、Webhook URLにコピーしたURLを設定してください。

Paystackの署名用シークレットの確認方法

Paystackのシークレットキー(sk_...)です。Paystackは、Webhookごとのシークレットではなく、アカウントキーを使用して署名を行います。

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

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

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

何 値
署名ヘッダー x-paystack-signature
署名の位置 ヘッダー値全体
何が署名されたのでしょうか {body}
署名 HMAC-SHA512、16進数エンコード
タイムスタンプ この送信者には使用されていません
リプレイ防止機能 なし - この送信者はタイムスタンプに署名しないため、すべての有効な署名は引き続き有効です
その秘密 プレーンテキストとして使用します。送信者が表示している通りに、そのまま貼り付けてください。

署名付きペイロードにおいて、{body} は、バイト単位でリクエスト本文の生のデータそのものです。

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

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

  1. Shopify Flow でワークフローを作成し、「Workflow Webhooks」トリガーを選択してください。
  2. 「**イベントの記録」**をクリックし、Paystackからテストイベントを送信してください(または、Workflow Webhooksの「テストを送信」機能をご利用ください)。これにより、Shopify Flowがデータの構造を学習します。
  3. 所有しているすべてのWebhookは同じFlowトリガーを起動するため、このワークフローをPaystackのみに限定するために、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 - エンドツーエンドでテストする

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

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

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

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

Webhookの認証が**「HMAC」**に設定され、プロバイダーとして「Paystack」が選択されていること、シークレットが入力されていること、そしてPaystackがアプリに表示されているとおりに(末尾のコードも含めて)URLへPOSTしていることをご確認ください。

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

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

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

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

関連情報