Help > Forum > ウェブサイトの統合 > ウェブフックのペイロードについて

ウェブフックのペイロードについて

Webhook ペイロードは、Web サイト Toolbox から別のサービスに送信されるデータを含むイベントオブジェクトです。イベントオブジェクトには、データ属性とその中にオブジェクト属性が含まれます。オブジェクト属性には、Webhook イベントの対象となるオブジェクトが含まれます。最も一般的なオブジェクトは API ドキュメントに記載されています。たとえば、user.updated Webhook イベントでは、ペイロードの data.object 属性は User オブジェクトになりますWebhook イベントの例を確認することをお勧めします

ウェブフックイベントによって返されるオブジェクトの中には、API エンドポイントが関連付けられていないものもあるため、まだ文書化されていません。

Webhook イベントが送信されるたびに、ペイロードとレスポンスは [統合]-> [Webhook] セクションに記録されます。ここで、ペイロードを確認して、どの属性が含まれているかを確認したり、データが期待どおりかどうかを判断したりできます。


If you still need help, please contact us.