リクエストヘッダー · 1
認証ヘッダー。
Authorizationstring必須
本番用のAPIキー。次の形式で渡します: Bearer ax_live_…
返り値 · 200
標準の { data, meta } エンベロープ。 data は WebhookOut 型の配列です。
エンベロープ
dataWebhookOut[]
結果オブジェクトの配列。
metaMeta
ページネーションとリクエストメタデータ。request_id、data_as_of、ontology_version を含みます。
WebhookOut
idinteger
Webhook ID。
urlstring
Webhook配信を受信するHTTPS URL。
eventsstring[]
購読しているイベントタイプ(例: ['new_filing', 'amendment'])。
activeboolean
Webhookが現在有効かどうか。
created_atstring
Webhookが作成された日時(ISO 8601)。
エラー
標準のHTTPステータスコードに加え、{ error: { code, message } } エンベロープ内で型付きの error.code を返します。
すべてのエンドポイントは共通の型付きエラーエンベロープ({ error: { code, message } })を返します。 全コードの一覧はエラーリファレンスを参照してください。