← Back to API docs

Public API documentation

Common Information changelog

Last updated 09 Jul 2026, 12:37 UTC.

Updated 09 Jul

Documented externalNotificationContent usage and push text behavior across content-related API docs.

api-docscontentscontentsviewsearchcontentpooltypesswaggerdoc
  • Added externalNotificationContent to contentType enum documentation where supported by content services.
  • Clarified that externalNotificationContent is intended for custom external push scenarios.
  • Documented push text mapping for externalNotificationContent: title uses content creator full name and body uses content title.

Expanded aiassistant API docs for analytics category, subcategory, and unanswered query variants.

aiassistantapi-docs
  • Documented new find type values for analytics categories, subcategories, and unanswered topics.
  • Added categoryId query parameter usage and clarified pagination parameter applicability across analytics variants.
  • Extended OpenAPI response schema coverage for categories, subcategories, and unanswered analytics payloads.

Clarified imported-field restrictions and create defaults for groups, orgattributes, and orgattributecategories.

api-docsgroupsorgattributesorgattributecategories
  • Documented that the imported field defaults to false on create when omitted.
  • Documented that imported can only be changed by keephubAdmin or the system user.
  • Marked update behavior as internal-only where applicable.

Clarified users patch permissions and aligned users schema docs for loginMethod/imported fields.

api-docsusers
  • Updated users patch operation docs to state imported field access for keephubAdmin and system.
  • Added users.imported schema property and aligned loginMethod access wording with current permissions.
  • Removed readOnly from users.loginMethod and users.imported so privileged patch behavior matches the shared users schema.

Added top-level content hookurls for workflow approval/rejection callbacks and clarified webhook status derivation in contents and workflow API docs.

contentsworkflowswaggerdocapi-docs
  • Added top-level hookurls field to abstractContent schema (array of { url, active }) used for workflow content approval/rejection callbacks; payload sends _id, approvedBy, and createdBy.
  • Updated form.hookurls description to clarify it is a dedicated form-model abstraction separate from top-level content hookurls.
  • Updated contents find operation and webhookStatus query param description: top-level hookurls is now the primary source; form.hookurls serves as fallback for form content.
  • Updated workflow create operation to document that approve/reject actions trigger active content hook URLs with IDs-only payload.

Added top-level content hookurls for workflow approval/rejection callbacks and clarified webhook status derivation in contents and workflow API docs.

contentsworkflowswaggerdocapi-docs
  • Added top-level hookurls field to abstractContent schema (array of { url, active }) used for workflow content approval/rejection callbacks; payload sends _id, approvedBy, and createdBy.
  • Updated form.hookurls description to clarify it is a dedicated form-model abstraction separate from top-level content hookurls.
  • Updated contents find operation and webhookStatus query param description: top-level hookurls is now the primary source; form.hookurls serves as fallback for form content.
  • Updated workflow create operation to document that approve/reject actions trigger active content hook URLs with IDs-only payload.

Refreshed Keephub API docs layout and styling for improved navigation and changelog presentation.

generateDocumentationapi-docs
  • Updated the Redoc template, theme styling, and generated docs header and changelog presentation.

Updated audittrail Swagger docs to include roles in objectType enum filters.

audittrailapi-docs
  • Added roles as an accepted objectType value in audittrail query documentation.

Refreshed Keephub API docs styling for smoother sidebar navigation, search, buttons, and response panels.

api-docs
  • Applied a visual polish pass across the sidebar, navigation, search, button treatments, and response panels.

Test changelog rendering locally

api-docs

Initialized the API docs metadata source for last-updated timestamps and changelog tracking.

generateDocumentationswaggerInitConfapi-docs
  • Added the canonical docs metadata JSON source under documentation/.
  • Defined the initial public changelog entry for the docs metadata workflow.