For the complete documentation index, see llms.txt. This page is also available as Markdown.

Audit Logs

Audit log in BotDistrikt records or logs all the interactions and activities that occur within the chatbot system. It serves as a chronological history of events, actions, and data related to your chatbots’ operations.

Audit logs are essential for monitoring system usage, debugging issues, ensuring security compliance, and tracking changes made to chatbot configurations.

Key Information Captured

Each audit log entry contains the following fields:

  • ID: Unique identifier for each log entry

  • User: The user or system that performed the action

  • Action: The type of action performed (e.g. LOGIN, CREATED, UPDATED, DELETED)

  • Entity Name: The type of object affected (e.g. card, access, tag, text_prompt)

  • Entity ID: Unique identifier of the affected entity

  • Timestamp: Date and time when the action occurred

Types of Activities Logged

The audit log captures a wide range of events, including:

  • User interactions (e.g. logins, access events)

  • System events (e.g. automated processes)

  • Configuration changes (e.g. updates to chatbot content or settings)

  • Security-related actions (e.g. access control changes)

  • CRUD operations:

    • CREATED

    • UPDATED

    • DELETED

Entity Names

The queryable entity names in the platform are tabulated below

Entity Name
Description

access

Team member user access record

action_prompt

LLM Agent that outputs a value or JSON schema into a user attribute

action

Context change response modifying memory and variables

alibaba_cloud_app

Alibaba Cloud integration settings

assistant_app

Google Assistant integration settings

audio

Audio response from chatbot

azure_openai_app

Microsoft Azure OpenAI integration settings

broadcast

Bulk notification to multiple users

button

Clickable button attached to responses

card

Rich element with image, title, subtitle, buttons

chatbase_app

Chatbase integration settings

condition

Evaluates incoming message against context property and value

csv_export

CSV Export record

deepseek_app

DeepSeek integration settings

dialogflow_app

Dialogflow integration settings

docs_app

Google Docs integration settings

document

Document response from chatbot

facebook_app

Facebook App integration settings

facebook_page

Facebook Page integration settings

form_question

Form question inside a form

form

Fillable form in a linear flow

function

JavaScript function to modify or evaluate message context

group

Set of rules organizing bot topics and functionalities

image

Image response from chatbot

instagram_page

Instagram Page integration settings

integration_step

Integration step response

langfuse_app

Langfuse integration settings

llm_source

Source for LLM chunks, in the form of Website, Document, Google Docs or Google Sheets

openai_app

OpenAI integration settings

persisted_menu

Always-on clickable buttons at chat screen bottom

quick_reply

Transient button for user to respond to story

response_group

Text response from chatbot with random variant selection

response

Text response variant for random selection

rule

Conditions to evaluate message and select story response

salesforce_app

Salesforce integration settings

sheets_app

Google Sheets integration settings

skype_app

Skype integration settings

sms_app

SMS integration settings

step

One response in a story with position order

sticker

Sticker response from chatbot with emoji or set

story

Bot response with multiple response types and steps

tag

Label applied to users and models for filtering

teams_app

Microsoft Teams integration settings

telegram_app

Telegram integration settings

template

Bot Template to create a new bot from

text_prompt

LLM Agent that performs RAG and outputs a response

thread_comment

Comments in threads

thread

A group of comments for an entity

twitter_app

Twitter integration settings

vertexai_app

Google Vertex AI integration settings

video

Video response from chatbot

webchat_app_placement

Website Chat Widget variant settings

webchat_app

Website Chat Widget settings

webhook_app

Webhook to notify other applications on user message

webhook

API call response from chatbot to external systems

wechat_app

WeChat integration settings

whatsapp_app

WhatsApp integration settings

wit_app

Wit.ai integration settings

wrong_response

Tracked issue based on a message-response pair

zendesk_app

Zendesk integration settings

How to Access Audit Logs

To access the audit log, navigate to the side panel Settings β†’ Audit Log

Audit Log Dashboard

Viewing Changes

  • Hover over Entity Name to view the code block of changes made.

  • This allows you to inspect exactly what was modified during an update.

Action Types and JSON Data Deltas

1. Action: CREATED

The CREATED action indicates that a new record has been added to the database.

  • Visual Cue: Fields are highlighted in Green.

  • Behavior: Because there is no "previous state" for a new entity, the system displays the entire initial data set as an addition.

  • Example: When a user creates a new Text responses under "Responses", all defined attributes like name and is_active will appear in green to show they are now part of the system.

2. Action: UPDATED

The UPDATED action records modifications made to an existing record.

  • Visual Cue: Red Strikethrough (Old) and Green Highlight (New).

  • Behavior: The system performs a "delta" comparison. It shows you exactly what the value was before the change and what it became after the save.

  • Example: If a name is changed from "Hello World!" to "Good Morning 🌞", the log will display:

3. Action: DELETED

The DELETED action tracks the removal of a record from the system.

  • Visual Cue: All fields are highlighted in Red with a Strikethrough.

  • Behavior: The JSON snapshot represents the "final state" of the data immediately before it was removed. The red formatting indicates that this specific data set is no longer active or reachable.

  • Example: Deleting a Text will show the entire object struck through in red, serving as a historical record of what was removed.

Filtering Logs

You can use the filter function to refine and search for specific logs based on:

  • User

  • Action type

  • Entity

  • Date/time range

This helps quickly locate relevant events for troubleshooting or audits.

Add filter(s) to search through specific logs.

Example

An example log entry may show:

  • A user login event

  • A deleted card entity

  • The exact timestamp of when the action occurred

How to Apply Filters

  1. Click the + add filter button.

  1. Select category from the first dropdown.

  1. Choose your Operator (e.g., contains, equals).

  2. Input the Value or select it from the provided list/calendar.

  3. To remove a filter, click the trash icon πŸ—‘οΈ next to the filter row.

1. Filter by ID

Filter records based on their unique identifier.

  • Operators: equals, not equals, greater than, less than.

  • Use Case: Best for locating a specific log entry if you have the direct ID number.

2. Filter by User

Filter logs based on the person who performed the action.

  • Operators: equals, not equals.

  • Use Case: Auditing the activity of a specific team member or administrator.

3. Filter by Action

Filter by the type of action that occurred.

  • Available Values: CREATED, UPDATED, DELETED, INVITED, ACCEPTED, LOGIN, LOGOUT.

Actions on Entities / Objects

Track changes to specific objects within the platform (such as story changes or user access activities).

Use Case: Finding all instances of a specific behavior, such as seeing who has logged in recently or identifying all deleted entities.

  • CREATED: Logged when a new entity is initially added to the system. The associated JSON will show all initial values in green.

  • UPDATED: Logged whenever an existing entity is modified. The JSON delta will highlight exactly which values were changed.

  • DELETED: Logged when an entity is removed. This provides a final snapshot of the data before deletion.

4. Filter by Entity Name

Filter based on the name of the object being modified (e.g., a specific response group name).

  • Operators: equals, not equals, contains, not contains.

  • Use Case: Searching for all changes related to access management, or if want to search actions done to a specific story (even if you only remember a part of the story name, use "contains").

5. Filter by Entity ID

Filter based on the unique ID of the entity itself.

  • Operators: equals, not equals, greater than, less than.

  • Use Case: Tracking the entire lifecycle (creation, updates, deletion) of one specific entity e.g. tag, card, story across different points in time.

6. Filter by Timestamp

Narrow down logs by a specific date and time.

  • Modes:

    • Normal: Select a specific date from the calendar and a specific time.

    • Relative: (e.g., "Last 1 hour", "Last 7 days").

  • Operators: greater than (after), less than (before).

  • Use Case: Investigating incidents that occurred within a specific timeframe.

Notes

  • Logs are displayed in descending chronological order (most recent first).

  • All actions are recorded automatically and cannot be modified.

Last updated