13.2. Webhook のフォーマット

Webhook のフォーマットは常に同じです。以下の構造の XML ドキュメントでエンドポイントにポストします。

<?xml version="1.0" encoding="UTF-8"?>
<event>
  <type>application</type>
  <action>updated</action>
  <object>
    THE APPLICATION OBJECT AS WOULD BE RETURNED BY A GET ON THE ACCOUNT MANAGEMENT
    API
  </object>
</event>

<type> は、application、account など、イベントの主体を表します。<action> は、updated、created、deleted など、何が行われたかを表します。最後の <object> は、Account Management API によって返される、同じフォーマットの XML オブジェクト自体です。これを確認するには、インタラクティブな ActiveDocs (管理ポータルの右上隅にある疑問符 (?) アイコン → 3scale API Docs セクションから利用可能) を使用できます。

Webhook が 3scale によって実行されたことを保証する必要がある場合は、HTTPS Webhook URL を公開し、3scale の Webhook 宣言にカスタムパラメーターを追加します。たとえば、https://your-webhook-endpoint?someSecretParameterName=someSecretParameterValue となります。パラメーター名と値を指定します。続いて、Webhook エンドポイント内で、このパラメーター値があることを確認します。