Webhook エンドポイントはアカウントで発生するイベントを登録するために使用します。1つのエンドポイントで、複数の異なる種類のイベントを一度に登録することも、各イベントに別々のエンドポイントを設定することも可能です。
属性
- id文字列
- オブジェクトの一意の識別子です。
- object文字列 (値は webhookEndpoint)
- オブジェクトの種類を表す文字列です。同じ種類のオブジェクトの場合は同じ値を共有します。
- activeブール値
- Webhook エンドポイントがアクティブで、イベントを指定の URL に送信する場合は
trueのフラグ、Webhook エンドポイントが非アクティブで、呼び出しを指定の URL に送信しない場合はfalseのフラグです。 - createdAtタイムスタンプ
- オブジェクトが作成された時間です。Unix エポックからのミリ秒数で表されます。
- description文字列
- エンドポイントについての任意の長い説明です。
- eventSubscriptions配列 [文字列]
- 当該エンドポイントが登録するイベントのリストです。指定されていない場合や、
*に等しい場合は、すべてのイベントを登録します。登録可能なイベントについては、サポートされているイベントの種類を参照してください。 - metadataオブジェクト
- キーと値のペアで、オブジェクトにアタッチし、追加情報を構造化された形式で保存することができます。
- testブール値
- オブジェクトが、ライブモードの場合は
falseのフラグ、テストモードの場合はtrueのフラグです。 - url文字列
- 登録イベントが発生すると呼び出されるように登録された URL です。https エンドポイントである必要があります。
- updatedAtタイムスタンプ
- オブジェクトが最後に更新された時間です。Unix エポックからのミリ秒数で表されます。