BlueAI Events データ構造
イベントはシステム内で発生したアクション（リソースの作成・更新・削除など）を表します。Events API を使用して、組織内で発生したイベントを一覧・取得できます。
|
Event object
イベントはシステム内で発生したアクション（リソースの作成・更新・削除など）を表します。Events API を使用して、組織内で発生したイベントを一覧・取得できます。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | イベントの一意識別子（evt_ プレフィックス） |
object | string | 必須 | オブジェクトタイプ（常に "event"） |
type | string | 必須 | イベント種別（例: invoice.created, crm.deal.updated） |
organization_id | string | 必須 | イベントが発生した組織の ID |
data | object | 必須 | イベント発生時のリソースデータ |
previous_attributes | object | null | 任意 | 更新イベントの場合、変更前の属性値 |
request_id | string | null | 任意 | イベントをトリガーした API リクエストの ID |
created_at | string (ISO 8601) | 必須 | イベントの発生日時 |
{
"id": "evt_a1b2c3d4-5678-90ab-cdef-1234567890ab",
"object": "event",
"type": "invoice.created",
"organization_id": "org_abc123",
"data": {
"id": "inv_def456",
"object": "invoice",
"status": "draft",
"total_amount": 110000
},
"previous_attributes": null,
"request_id": "req_xyz789",
"created_at": "2026-01-15T10:30:00Z"
}イベント種別
以下は現在サポートされているイベント種別の一覧です。イベントの type フィールドにこれらの値が設定されます。
| 種別 | 説明 |
|---|---|
| invoice.created | 請求書が作成された |
| invoice.updated | 請求書が更新された |
| invoice.deleted | 請求書が削除された |
| invoice.approved | 請求書が承認された |
| invoice.sent | 請求書が送信された |
| invoice.paid | 請求書が入金された |
| invoice.cancelled | 請求書がキャンセルされた |
| crm.deal.created | CRM 商談が作成された |
| crm.deal.updated | CRM 商談が更新された |
| crm.deal.deleted | CRM 商談が削除された |
| crm.deal.stage_updated | CRM の商談ステージが変更された |
| crm.company.created | CRM の取引先企業が作成された |
| crm.company.updated | CRM の取引先企業が更新された |
| crm.company.deleted | CRM の取引先企業が削除された |
| crm.contact.created | CRM の連絡先が作成された |
| crm.contact.updated | CRM の連絡先が更新された |
| crm.contact.deleted | CRM の連絡先が削除された |
| crm.activity.created | CRM のアクティビティが作成された |
| crm.activity.deleted | CRM のアクティビティが削除された |
| attendance.record.clocked_in | 出勤打刻が記録された |
| attendance.record.clocked_out | 退勤打刻が記録された |
| mail.campaign.sent | メールキャンペーンが送信された |
| forms.response.submitted | フォーム回答が送信された |
| customer.created | 顧客が作成された |
| customer.updated | 顧客が更新された |
| customer.deleted | 顧客が削除された |
| conversion.completed | 帳票変換が完了した |
エンドポイント
GET
/api/v1/events組織内のイベント一覧を取得します。新しい順に返却されます。
クエリパラメータ
| type | string | フィルタするイベント種別（例: invoice.created） |
| limit | integer | 取得件数（デフォルト: 20、最大: 100） |
| starting_after | string | カーソルページネーション用のイベント ID |
GET
/api/v1/events/{id}指定した ID のイベントを取得します。
パスパラメータ
| id | string | 取得するイベントの ID（evt_ プレフィックス） |