twentyhq/twenty sdk/v2.55.0

on GitHub

Five breaking changes ship in this release. createWebhook requires a roleId. objectMetadata.readability, writability, and sharingReach are removed from GraphQL. setRecordGeneralAccess is replaced by setRecordPrivate. IconsProvider moves out of twenty-ui/icon, cutting ~2 MB from affected bundles. The workspace field allowedIframeOrigins is renamed.

defineHealthCheck gains runOnUserPreferences: true for member-scoped checks. App manifests accept defineRelatedRecordPath. The SEND_CHAT_MESSAGE workflow step now roundtrips through pull and apply.

twenty local is restored: start, stop, status, logs, upgrade, and reset. Validation failures now include the server's error code and friendly message. The CLI no longer rejects a manifest that references the workspace default role without a local definition.

⚠️ Breaking changes

• allowedIframeOrigins on the workspace object is renamed — update any queries or mutations that reference it; the new updateWorkspaceIframeMediaPermissions mutation adds per-origin microphone and camera grants. (#29217) by @bosiraphael
• createWebhook now requires a roleId; updateWebhook accepts an optional roleId to change it; creating or editing a webhook now also requires the ROLES permission. (#29273) by @charlesBochet
• defineSettingsMenuItem now accepts an optional slug (lowercase kebab-case, max 64 chars) used as the URL hash for that settings tab; Connect and Reconnect now land on the app's first preferences tab. (#29355) by @martmull
• Replace setRecordGeneralAccess with setRecordPrivate(recordId, isPrivate) — a record is now either private (creator and direct shares only) or role-governed. (#29383) by @charlesBochet
• IconsProvider has moved out of twenty-ui/icon to a new export path; import it from there to stop inlining all 4,200 Tabler icons in bundles that only need the provider. (#29386) by @FelixMalfait
• objectMetadata.readability, writability, readabilityParentFieldUniversalIdentifiers, sharingReach, and fieldMetadata.writability are removed from the GraphQL metadata API; remove them from all queries, fragments, and SDK calls. (#29390) by @charlesBochet

🌟 Highlights

• IconsProvider has moved out of twenty-ui/icon — update the import path or every bundle that touches it inlines all 4,200 Tabler icons. (#29386)
• createWebhook now requires a roleId; pass the role that governs what the webhook can read. (#29273)
• objectMetadata.readability, writability, sharingReach, and fieldMetadata.writability are removed from the GraphQL API — remove them from queries and fragments. (#29390)
• setRecordGeneralAccess is gone; use setRecordPrivate(recordId, isPrivate) to control private vs. role-governed access. (#29383)
• defineHealthCheck now accepts runOnUserPreferences: true for a member-scoped check; that handler receives { userWorkspaceId: string }. (#29249)
• twenty local is restored — start, stop, status, logs, upgrade, and reset are available again for local development. (#29301)

✨ New features

• defineHealthCheck now accepts runOnUserPreferences: true to declare a member-only check; the handler receives { userWorkspaceId: string } and the check does not run in workspace settings. (#29249) by @ehconitin
• runMyApplicationHealthCheck(applicationId) is now available as a GraphQL mutation to trigger a member health check; it requires a user session and CONNECTED_ACCOUNTS. (#29250) by @ehconitin
• The SDK/CLI frontend component render wrapper now accepts compiled source and record props directly and returns a promise that resolves after the initial React commit. (#29263) by @Weiko
• Related record paths now carry an isInherent flag; an inherent path applies whenever the source record is readable by any means, not only when access starts on that object. (#29292) by @charlesBochet
• defineRelatedRecordPath is now available in app manifests; it takes universalIdentifier, objectUniversalIdentifier, firstFieldMetadataUniversalIdentifier, optional second/third field identifiers, and optional isInherent. (#29328) by @charlesBochet
• SEND_CHAT_MESSAGE workflow steps are now supported in twenty app pull and twenty app apply; the step input carries workspaceMemberId, title, text, and an optional toolCall. (#29363) by @FelixMalfait

💅 Improvements & UX

• CLI validation failures now include the server's error code and friendly message; --json output exposes them under error.details.validationErrors. (#28816) by @prastoin
• chargeCredits calls from app logic now appear under APP_OPERATION in the monitoring page instead of being mixed into CODE_EXECUTION. (#29241) by @martmull
• Ada DM and Global inbox behavior modes are now readable and writable through GraphQL; the added enum shifts generated SDK type indices. (#29320) by @bosiraphael

🐛 Bug fixes

• The CLI no longer rejects app build, plan, or apply when a valid pulled manifest references the workspace default role without a local role definition. (#29318) by @Weiko

🔧 Developer & API

• The CLI now stores a dependency export map alongside the built bundle so AI-compiled components can reuse the app's existing shared dependencies without reinstalling. (#28469) by @Weiko
• twenty local start [version], stop, status, and logs are restored for managing a full local Twenty environment without a saved remote or app directory. (#29301) by @Weiko
• twenty local upgrade [version] and twenty local reset are now available for pulling a new image over an existing container and for explicit data deletion. (#29302) by @Weiko

Full Changelog: sdk/v2.54.0...sdk/v2.55.0