docs(develop-from-scratch): update tutorial for @tailor-platform/sdk#132
Merged
Merged
Conversation
Bring the SDK tutorial in line with the current @tailor-platform/sdk API. - Remove `workspaceId`/`WORKSPACE_ID` from `tailor.config.ts` in all steps; it is no longer a valid `defineConfig` field (fails to compile). Workspace is supplied at deploy time via TAILOR_PLATFORM_WORKSPACE_ID / --workspace-id, and the app `id` is auto-injected on first deploy. - Step 1: update Deploy instructions to TAILOR_PLATFORM_WORKSPACE_ID. - Step 4: webhook executor `body:` -> `requestBody:` (with `body:`, the SDK drops the payload and the callback param is untyped); fix deleted-trigger context field `record` -> `oldRecord`.
anukiransolur
approved these changes
Jun 8, 2026
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
2 participants
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.
What
Updates the develop-from-scratch tutorial to match the current
@tailor-platform/sdkAPI. The pages were already on the new SDK for most things (package name, array enums,resolver:key,@tailor-platform/kysely-type, object-config executor,src/resolver/path) — these were the remaining stragglers.Changes
workspaceId: process.env.WORKSPACE_ID(and theWORKSPACE_IDguard) fromtailor.config.ts. It is no longer a validdefineConfigfield — it fails to compile (TS2322: Type 'string' is not assignable to type 'never'). Workspace is now provided at deploy time; the appidis auto-injected on first deploy.TAILOR_PLATFORM_WORKSPACE_ID(with--workspace-idshown as an alternative).body:→requestBody:. Withbody:, the SDK does not recognize the field (callback param is untyped —TS7031— and the payload is silently dropped). Also fixed the deleted-trigger context fieldrecord→oldRecord.Companion templates PR
The source code these pages link to (
tailor-platform/templates/docs/build-from-scratch/sdk) is migrated in tailor-platform/templates#107.