Audit Logs

Audit logs are essential for maintaining security, compliance, and operational transparency by automatically recording every significant action performed in your ChatBotKit account. Each log entry captures detailed information about what action was performed, who performed it, when it occurred, and what resources were affected.

Understanding Audit Logs

Audit logs capture a wide range of activities including resource creation, updates, deletions, and access operations. Each audit log entry includes:

• Action details: The type of operation performed (create, update, delete, etc.)
• Resource information: The specific resources affected by the action
• User context: Who performed the action and from which IP address
• Temporal data: Precise timestamps for when the action occurred
• Change tracking: Old and new values for update operations
• Request metadata: User agent, session information, and other contextual data

This comprehensive logging enables you to track user behavior, investigate security incidents, meet compliance requirements, and understand how your resources are being used and modified over time.

Listing Audit Logs

To retrieve audit logs for your account, you can query the audit log list endpoint with various filtering options to find specific activities or narrow down your search to particular resources or time periods.

You can filter audit logs by specific resources using query parameters:

Available filter parameters include:

• action: Filter by specific action types (create, update, delete, etc.)
• blueprintId, botId, datasetId: Filter by specific resource IDs
• recordId, skillsetId, abilityId: Filter by related resource IDs
• fileId, secretId, portalId: Filter by integration resources
• webhookId, sessionId: Filter by connection and session data
• cursor, order, take: Standard pagination parameters

The response includes detailed information about each logged action:

Use Cases for Audit Logs

Audit logs serve several critical purposes:

• Security Monitoring: Track unauthorized access attempts and suspicious activities
• Compliance Auditing: Meet regulatory requirements for activity logging and data governance
• Troubleshooting: Investigate issues by reviewing recent changes to configurations
• Usage Analysis: Understand how resources are being utilized and modified
• Change Management: Track who made specific changes and when they occurred
• Accountability: Maintain clear records of all system modifications

Important: Audit logs are read-only and cannot be modified or deleted. They provide an immutable record of account activity for security and compliance purposes. Logs are retained according to your account's data retention policy.