Skip to main content
Version: Latest (4.0.0)

Event Retention

Event Retention controls how long each event type is kept in cidaas before it is removed. In Trustdesk this lives under Reports → Event Retention. You configure a days to live value per event type, within platform-defined bounds.

Reports Changelog User Activity
Configurable events only

The Trustdesk view lists only event types where retention is configurable. Other events are not shown and keep their platform defaults.

Why configure retention

Compliance and data minimisation

Keep audit and activity data only as long as your policies require.

Operational focus

Shorter retention for high-volume event types reduces noise and storage growth.

Per-event control

Set different lifetimes for changelog events versus user-activity events, within allowed min and max days.

How retention works

Days to live

Each configurable event type has a days to live value: after that many days, older events of that type are removed.

ConceptMeaning
Days to liveHow long events of this type are kept
DefaultPlatform default for that event type
Min / maxAllowed range when you edit retention
CustomCurrent value differs from the default
Never expireIf days are set to 0 (when allowed), these events are not deleted by retention

When you edit a value, Trustdesk can show an indicative roll-off date: events older than the configured setting will be removed on that date.

Categories in Trustdesk

Filter the list by category or object type. The retention UI focuses on:

ChangelogConfiguration and system change events used by Change Logs
User ActivityEnd-user action events used by User Activities

Related but separate: Webhooks deliver events in near real time to your systems. Retention decides how long historical changelog and user-activity data stays available to query inside cidaas.

How to configure retention

1
Open Event Retention
In Trustdesk go to Reports → Event Retention.
2
Find an event type
Search or filter by category (Changelog / User Activity) and object type.
3
Edit days to live
Open Edit, set a value within the allowed min and max, or reset to the default.
4
Save
Confirm the change. A Custom badge appears when the value differs from the default.

Access

Access to Event Retention in Trustdesk is role-gated. Typical roles that can open the view include:

ADMINSECONDARY_ADMINANALYSTREPORTINTEGRATION_MANAGERINTEGRATION_VIEWER
Permission to change

Loading the list and changing retention can require different permissions. If you can view the page but cannot save, Trustdesk shows that retention changes are not available due to missing permission.

API reference

Retention is managed by webhook-srv. Full OpenAPI docs:

OperationMethodPathOpenAPI
List retention settingsGET/webhook-srv/eventdescriptions/retentionList Event Retention Settings
Update retentionPATCH/webhook-srv/eventdescriptions/retentionUpdate Event Retention Settings

Scopes: cidaas:eventdescriptions_retention_read (list), cidaas:eventdescriptions_retention_write (update).

List query parameters:

ParameterValuesNotes
categoryall, changelog, useractivityFilters retention-configurable event types
typeObject type stringsRepeatable filter for object types

PATCH body: a map of event description id → days to live (number), within each event’s min and max bounds.

Query historical data with the related APIs:

Need Support?

Please contact us directly on our support page or reach out to cidaas support at [email protected].