概要

APIから更新情報を受け取るには、Webhookのような仕組みを活用すると便利です。Pio APIは、_RESTful_方式によりWebhookに対応しています。そのため、Webhookを手動で設定・管理する必要がありません。一般的なHTTP方式により、フックの作成、更新、一覧取得、削除が行えます。Pio APIで明確に定義されたeventsにより、フックがトリガーされます。

警告

メッセージが正常に送信されたとみなされるには、インテグレーションによる応答が2XXステータスコードで5秒以内に行われる必要があります。

インテグレーションにおいては、各ショップのサポートされているイベントごとにフックを作成できます。フックが正常に動作するには、特定のイベントのtarget_urlがペイロードを受け入れ、200を返す必要があります。次のセクションでは、サポートされているすべてのイベントと、対応するペイロードを一覧で確認します。

情報

target_urlは、インターネット上で公開されており、HTTPSを使用したものである必要があります。

Pioがメッセージ送信時に2XXを受信できなかった場合、最大で24時間にわたり再送信されます。リクエストの再送時には同一のX-Pio-Delivery-Idヘッダーが付与され、複数回の試行で同一の結果が得られるようになっています。