Audit Logs

Overview

EngageFabric’s Audit Logging system provides comprehensive tracking of all administrative actions, security events, and resource changes. This is essential for:

Compliance: Meet regulatory requirements (SOC 2, GDPR)
Security Monitoring: Detect suspicious activity in real-time
Accountability: Track who made changes and when
Debugging: Investigate issues with full audit trails

Audit logs are only accessible to users with Admin or Owner roles.

Querying Audit Logs

List Audit Logs

Retrieve paginated audit logs with optional filters:

curl -X GET "https://api.engagefabric.com/admin/audit-logs" \
  -H "Authorization: Bearer your-jwt-token" \
  -G \
  -d "tenantId=your-tenant-id" \
  -d "limit=50" \
  -d "offset=0"

Response:

{
  "data": [
    {
      "id": "log-uuid",
      "tenantId": "tenant-uuid",
      "projectId": "project-uuid",
      "adminId": "admin-uuid",
      "eventType": "XP_GRANTED",
      "action": "adjust_xp",
      "resource": "player",
      "resourceId": "player-uuid",
      "changes": {
        "before": { "xp": 1000 },
        "after": { "xp": 1500 }
      },
      "details": {
        "playerId": "player-uuid",
        "playerName": "John Doe",
        "amount": 500,
        "reason": "Customer support compensation"
      },
      "ipAddress": "192.168.1.1",
      "userAgent": "Mozilla/5.0...",
      "createdAt": "2025-12-01T10:30:00Z"
    }
  ],
  "total": 156,
  "limit": 50,
  "offset": 0
}

Get Single Audit Log

curl -X GET "https://api.engagefabric.com/admin/audit-logs/{logId}" \
  -H "Authorization: Bearer your-jwt-token"

Security Monitoring

Suspicious Activity

Retrieve audit logs flagged as suspicious:

curl -X GET "https://api.engagefabric.com/admin/audit-logs/suspicious/activity" \
  -H "Authorization: Bearer your-jwt-token" \
  -G \
  -d "tenantId=your-tenant-id" \
  -d "limit=20"

Suspicious activity includes:

Multiple failed authentication attempts
Unusual API key usage patterns
High-volume data exports
Permission escalation attempts

Recent Security Events

Get security-related events from the past hours:

curl -X GET "https://api.engagefabric.com/admin/audit-logs/security/events" \
  -H "Authorization: Bearer your-jwt-token" \
  -G \
  -d "hours=24" \
  -d "limit=100"

Resource Audit Trail

Track all changes to a specific resource:

curl -X GET "https://api.engagefabric.com/admin/audit-logs/resource/player/{playerId}" \
  -H "Authorization: Bearer your-jwt-token" \
  -G \
  -d "limit=50"

Supported Resource Types:

player - Player records
quest - Quest definitions
adventure - Adventure/season configurations
leaderboard - Leaderboard settings
rule - Rules engine rules
api-key - API key management

Event Types

Event Type	Description
`XP_GRANTED`	XP added or removed from player
`CURRENCY_GRANTED`	Currency adjusted
`LEVEL_UP`	Player level increased
`QUEST_COMPLETED`	Quest marked as completed
`BADGE_AWARDED`	Badge granted to player
`API_KEY_CREATED`	New API key generated
`API_KEY_REVOKED`	API key deactivated
`USER_LOGIN`	Admin user logged in
`USER_LOGOUT`	Admin user logged out
`SETTINGS_CHANGED`	Project or tenant settings modified
`RULE_CREATED`	New rule added to rules engine
`RULE_UPDATED`	Existing rule modified

Audit Log Retention

Tier	Retention Period
Free	7 days
Starter	30 days
Pro	90 days
Enterprise	Custom (up to unlimited)

Audit logs older than your retention period are automatically deleted. Export important logs before they expire.

Best Practices

Regular Reviews

Schedule weekly reviews of audit logs to identify unusual patterns or unauthorized access attempts.

Export for Compliance

Export audit logs regularly for long-term storage and compliance requirements.

Set Up Alerts

Configure webhook notifications for critical security events to enable real-time monitoring.

Document Actions

Always provide meaningful reasons when making admin adjustments to maintain a clear audit trail.

Player Management

Learn about admin player operations that generate audit logs

Webhooks

Set up notifications for audit events

Getting Started

Guides

Core Concepts

API Reference

Endpoints

SDKs

Resources

Overview

Querying Audit Logs

List Audit Logs

Get Single Audit Log

Security Monitoring

Suspicious Activity

Recent Security Events

Resource Audit Trail

Event Types

Audit Log Retention

Best Practices

Regular Reviews

Export for Compliance

Set Up Alerts

Document Actions

Player Management

Webhooks

​Overview

​Querying Audit Logs

​List Audit Logs

​Get Single Audit Log

​Security Monitoring

​Suspicious Activity

​Recent Security Events

​Resource Audit Trail

​Event Types

​Audit Log Retention

​Best Practices

Regular Reviews

Export for Compliance

Set Up Alerts

Document Actions

​Related

Player Management

Webhooks

Overview

Querying Audit Logs

List Audit Logs

Get Single Audit Log

Security Monitoring

Suspicious Activity

Recent Security Events

Resource Audit Trail

Event Types

Audit Log Retention

Best Practices

Related