記事のサマリー(TL;DR)
- Amazon EventBridge経由で受信できるWebhookおよびEventsペイロードの上限が、256KBから1MB(1,000,000バイト)に引き上げられました。
- この変更は全APIバージョンに自動的に適用され、既存のEventBridgeサブスクリプションを更新する必要はありません。
- バリアントの多い商品やライン項目の多い注文などの大きなリソースは、インラインで届くようになり、アプリ側での追加のAdmin APIリクエストやpayload_urlダウンロードが減少します。
詳細
変更内容
これまでAmazon EventBridgeでの配信は、ペイロードサイズが256KBに制限されていました。
- クラシックWebhookのペイロードが256KBを超えると、
{"id": ...}という最小限の本文にフォールバックし、完全なリソースを取得するには追加のAdmin APIリクエストが必要でした。 - Eventsペイロードが256KBを超えると、ラージペイロードのオーバーフロー処理が使われ、インラインのペイロードの代わりに一時的なダウンロードリンクである
payload_urlが配信されていました。
Shopifyは現在、生のUTF-8ペイロードを最大1,000,000バイトまで、Amazon EventBridgeのパートナーイベントソースに直接送信します。これは、EventBridgeの1MiBエントリ上限のうち、source・detail-type・detailのエンベロープ分の余白を残した上での上限です。バリアントの多い商品やライン項目の多い注文といった大きなリソースも、現在はインラインで届くようになり、アプリ側での追加のAdmin APIリクエストやpayload_urlダウンロードが減少します。
1,000,000バイトを超えるペイロードについては、既存のフォールバック動作が維持されます。クラシックWebhookは{"id": ...}を送信し、Events配信はpayload_url・payload_size_bytes・expires_atを含むスタブペイロードを送信します。
対応が必要な作業
この変更について、特別な対応は必要ありません。shopify.app.tomlで設定されている既存のEventBridgeサブスクリプション、またはGraphQL Admin API(eventBridgeWebhookSubscriptionCreateおよびwebhookSubscriptionCreate)経由で作成されたサブスクリプションは、全APIバージョンにわたって自動的に最大1MBのインラインペイロードを受信します。
アプリが大きな配信をどのように扱っているかを確認する場合は、以下を検討するようShopifyは案内しています。
- 1MBを超えるペイロードに対するフォールバック処理(クラシックWebhookの場合は
{"id": ...}、Eventsの場合はpayload_url)をそのまま維持する、あるいはinclude_fieldsや対象を絞ったevents.subscriptionクエリの選択によってペイロードを縮小する。 - EventBridgeルールに接続されているダウンストリームのAWSターゲットが、1MBまでのイベントを受け入れられることを確認する。ターゲット側でより小さい上限が設定されている場合は、EventBridgeのinput transformerを設定する。