イベント · メンバーとアクセス
api_key.expiring
APIキーの期限が近い
APIキーの期限が7日以内に切れます。このイベントは有効期限ごとに一度だけ送信されます。
- オブジェクトの種類
- api_key
- 配信先
- adminロールのWebhook
ペイロード
idstring必須イベントのID(
evt_…)。webhook-idヘッダーとしても送信されます。重複した配信を破棄するために使ってください。typestring必須指定できる値:
api_key.expiringcreated_atstring (date-time)必須変更が発生した日時(UTC)。
org_idinteger必須api_versionstring必須dataスキーマの契約のバージョン。sequenceintegerWebhook内での配信の連番(テストイベントにはありません)。
payloadstring必須thinはdataがないことを意味します:APIでオブジェクトを読み取ってください。指定できる値:
fullthindataobjectフィールド
days_leftinteger必須キーの有効期限までの残り日数。
testboolean必須POST /v1/webhooks/{webhook_id}/testで送信されたテストイベント。
配信の例
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "api_key.expiring",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "api_key",
"id": "14"
},
"payload": "full",
"data": {
"api_key": {
"id": 14,
"name": "CRM sync",
"prefix": "kb_3f9a",
"kind": "org",
"role": "editor",
"scopes": [
"cards:read",
"cards:write"
],
"expires_at": "2026-10-31T00:00:00Z"
},
"days_left": 6
},
"test": false
}イベントの受信
各配信は、このJSONボディを持つPOSTリクエストとしてWebhookの受信先URLに送られます。ボディを信頼する前にwebhook-signatureヘッダー(Standard Webhooks)を検証し、数秒以内に2xxステータスで応答してから、処理を行ってください。1つのWebhookへの配信はイベントの順序を保ちます。失敗した配信は間隔を広げながら再試行されます。
新しいイベントタイプや新しいフィールドはいつでも追加されることがあります。知らないタイプとフィールドは無視してください。