docs: consolidate deletion audit events on streaming-events page (replaces #695, #709, #712, #722) - #737
Draft
jordanc-relevanceai wants to merge 1 commit into
Draft
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This was referenced Jul 31, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Consolidates the four open PRs that all documented deletion audit events on
enterprise/streaming-events.mdxinto a single change, and corrects the attribute tables against the OTEL event definitions inrelevance-api-node. Branched frommain.Adds to Supported events:
conversation_deleted— new### Conversation eventssectionworkforce_task_deleted— under Workforce eventsworkforce_type— new optional attribute on the existingworkforce_deletedeventtrigger_deleted— new### Trigger eventssectionknowledge_table_deleted— new### Knowledge eventssectionReplaces these PRs (now closed)
workforce_task_deletedconversation_deleted,workforce_task_deletedtrigger_deleted,knowledge_table_deletedconversation_deleted,workforce_task_deleted,workforce_type#709 and #722 were near-duplicates of each other (both drafted from
relevance-api-node#16143) and #695 documented the sameworkforce_task_deletedevent a month earlier. Merging them as-is would have produced duplicate event entries on one page.Corrections applied during consolidation
Each was verified against the event definitions in
relevance-api-node:agent_idonconversation_deletedis optional, not required. docs(TSP-1339): add conversation_deleted and workforce_task_deleted audit events #709 and docs(TSP-1348): add deletion audit events to streaming-events page #722 both marked itYes. Code:.optional()inapps/nodeapi/src/modules/shared/services/data_streaming/otel/definitions/audit_logs/conversations.ts.workforce_idis not an attribute ofworkforce_task_deleted. docs(TSP-1339): add conversation_deleted and workforce_task_deleted audit events #709 and docs(TSP-1348): add deletion audit events to streaming-events page #722 both listed it as required. The event defines onlyworkforce_task_id— seeaudit_logs/workforces.ts.workforce_task_idandworkforce_typeare not attributes ofconversation_deleted. docs(TSP-1348): add deletion audit events to streaming-events page #722 added both to that event's table.conversation_deleteddefines onlyconversation_idandagent_id.workforce_typevalues are not"direct"/"cascade". docs(TSP-1348): add deletion audit events to streaming-events page #722 documented those. The field holds the workforce's configured type (e.g.chat) and lives onworkforce_deleted, which is where it is documented here.trigger_provider, notintegration_provider. Add trigger_deleted and knowledge_table_deleted OTEL audit events to streaming events docs #712 used the latter. Seeaudit_logs/triggers.ts.trigger_provideris not limited toexternal_relaytriggers. Add trigger_deleted and knowledge_table_deleted OTEL audit events to streaming events docs #712 said it only appears for relay-type triggers; the code describes it as present for any trigger backed by an integration. Provider values are lowercase (slack,gmail), not title-case.trigger_typeis a free-form string, so the three known values are given as examples rather than a closed set.Decisions worth a look
conversation_deletedgets its own section rather than sitting under Agent events (docs(TSP-1339): add conversation_deleted and workforce_task_deleted audit events #709's placement). This matches how the code groups it —conversationEventsis a separate definition file from the agent events — and keeps the Agent events section focused on the agent entity itself.Test plan