イベント
組織で何かが変更されたときにWebhookが受信するイベントタイプは60種類です。特定のタイプ、またはcard.*のようなマスクを購読します。
カード
- card.archivedカードがアーカイブされた
- card.createdカードが作成された
- card.deletedカードが削除された
- card.index_failedカードのインデックス作成に失敗した
- card.indexedカードのインデックスが作成された
- card.movedカードが移動された
- card.published下書きが新しいカードとして公開された
- card.restoredカードが復元された
- card.updatedカードが更新された
検証
- card.unverifiedカードの信頼が取り消された
- card.verifiedカードが検証された
- verification.expired検証の期限が切れた
- verification.requested検証が依頼された
コレクションとフォルダー
- collection.createdコレクションが作成された
- collection.deletedコレクションが削除された
- collection.updatedコレクションが更新された
- folder.createdフォルダーを作成しました
- folder.deletedフォルダーを削除しました
- folder.updatedフォルダーが更新された
共同作業
- announcement.readお知らせが読まれた
- announcement.sentお知らせが送信された
- comment.createdコメントが追加された
- comment.resolvedコメントスレッドが解決済みになった
- draft.approved下書きが承認された
- draft.created下書きが作成された
- draft.publish_requested公開の承認が申請された
質問と回答
- access_request.createdアクセスが申請された
- access_request.resolvedアクセス申請が処理された
- gap.detectedナレッジギャップが検出された
- question.answered質問に回答した
- question.feedback_created回答が評価された
- question.unanswered質問に回答できなかった
メンバーとアクセス
- api_key.createdAPIキーが作成された
- api_key.expiringAPIキーの期限が近い
- api_key.revokedAPIキーが取り消された
- app.authorizedアプリが認可された
- app.revokedアプリの認可が取り消された
- group.createdグループを作成しました
- group.deletedグループを削除しました
- group.member_addedグループにメンバーが追加された
- group.member_removedグループからメンバーが削除された
- group.updatedグループが更新された
- user.createdユーザーが作成された
- user.deactivatedユーザーが無効化された
- user.offboardedユーザーがオフボーディングされた
- user.updatedユーザーが更新された
ソースとインポート
- import.document_failedドキュメントのインポートに失敗した
- import.sync_completedインポートの同期が完了した
- source.connection_lostソースの接続が切れた
- source.sync_completedソースの同期が完了した
- source.sync_failedソースの同期に失敗した
ジョブとエクスポート
- export.readyエクスポートの準備ができた
- job.completedジョブが完了した
- job.failedジョブが失敗した
料金と請求
- credits.lowクレジット残高が少ない
- invoice.issued請求書が発行された
- invoice.paid請求書が支払われた
- subscription.updatedサブスクリプションが更新された
Webhookのサービスイベント
- webhook.endpoint_disabledWebhookが無効になった
- webhook.pingテストイベント
イベントの受信
各配信は、このJSONボディを持つPOSTリクエストとしてWebhookの受信先URLに送られます。ボディを信頼する前にwebhook-signatureヘッダー（Standard Webhooks）を検証し、数秒以内に2xxステータスで応答してから、処理を行ってください。1つのWebhookへの配信はイベントの順序を保ちます。失敗した配信は間隔を広げながら再試行されます。
新しいイベントタイプや新しいフィールドはいつでも追加されることがあります。知らないタイプとフィールドは無視してください。