Record an audit event for one of your customers' organizations
POST /v1/audit_log_events: Record an audit event for one of your customers' organizations.
POST /v1/audit_log_events
Audit Logs product. The event is validated against its action’s schema (audit_log_schema_not_found when the action has none) and stored for the plan’s retention (7 days Free, 90 days Pro, 1 year Business, configurable on Enterprise). With an Idempotency-Key the event is recorded once per organization and key; a replay returns the original event, the same key with a different event answers idempotency_key_reused. Bounds 50 targets, 50 metadata keys per object (keys up to 40 characters, values up to 500), occurred_at at most 5 minutes ahead and 1 year back. Accepted events also reach the environment’s log stream destinations and the organization’s own portal destinations (action, actor, targets; never names, metadata or context).
- Scope
audit_log_events:write- Auth
- Secret key (
sk_…) - Since
- 1.1
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”organization_idstring RequiredeventAuditLogEventInput Required
Responses
Section titled “Responses”- 201 The recorded event (or the original event of a replayed Idempotency-Key). AuditLogEvent
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/audit_log_events" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "event": { "action": "user.signed_in", "occurred_at": "2026-01-15T09:30:00Z", "version": 1, "actor": { "type": "default", "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "metadata": { "plan": "enterprise" } }, "targets": [ { "type": "default", "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "metadata": { "plan": "enterprise" } } ], "context": { "location": "example_location", "user_agent": "example_user_agent" }, "metadata": { "plan": "enterprise" } }}'const response = await fetch("https://api.ohauthcat.com/v1/audit_log_events", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "event": { "action": "user.signed_in", "occurred_at": "2026-01-15T09:30:00Z", "version": 1, "actor": { "type": "default", "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "metadata": { "plan": "enterprise" } }, "targets": [ { "type": "default", "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "metadata": { "plan": "enterprise" } } ], "context": { "location": "example_location", "user_agent": "example_user_agent" }, "metadata": { "plan": "enterprise" } } }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/audit_log_events", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "event": { "action": "user.signed_in", "occurred_at": "2026-01-15T09:30:00Z", "version": 1, "actor": { "type": "default", "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "metadata": { "plan": "enterprise", }, }, "targets": [ { "type": "default", "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "metadata": { "plan": "enterprise", }, }, ], "context": { "location": "example_location", "user_agent": "example_user_agent", }, "metadata": { "plan": "enterprise", }, }, },)data = response.json(){ "object": "audit_log_event", "id": "ale_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "action": "user.signed_in", "version": 1, "occurred_at": "2026-01-15T09:30:00Z", "created_at": "2026-01-15T09:30:00Z", "actor": { "type": "default", "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "metadata": { "plan": "enterprise" } }, "targets": [ { "type": "default", "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "metadata": { "plan": "enterprise" } } ], "context": { "location": "example_location", "user_agent": "example_user_agent" }, "metadata": { "plan": "enterprise" }}