feat(KNO-11417): Docs for Update User / Tenant / Object#1310
Open
andy-knock wants to merge 1 commit intomainfrom
Open
feat(KNO-11417): Docs for Update User / Tenant / Object#1310andy-knock wants to merge 1 commit intomainfrom
andy-knock wants to merge 1 commit intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
andy-knock
commented
Feb 10, 2026
| ### Function steps | ||
|
|
||
| A function is a step in a workflow that does something to the data being passed in your trigger call. You can use functions by entering the workflow builder and adding function steps onto the canvas. | ||
| A function is a step in a workflow that does something to the data being passed in your trigger call. You can use functions by entering the workflow builder and adding function steps onto the canvas. In the workflow builder, functions are grouped in tabs. The **Data functions** tab includes steps that update data in Knock during a workflow run. |
Contributor
Author
There was a problem hiding this comment.
phrasing check here about the differences of Data functions.
andy-knock
commented
Feb 10, 2026
| section: Designing workflows | ||
| --- | ||
|
|
||
| The **Data functions** tab in the workflow builder includes three steps that update data in Knock during a workflow run: **Update user**, **Update tenant**, and **Update object**. They all work the same except Update object doesnt't support "Current object" mode. Use them when you need to change a [user](/concepts/users), [tenant](/concepts/tenants), or [object](/concepts/objects) based on workflow context so that downstream steps, [audiences](/concepts/audiences), or other workflows see the updated data. |
Contributor
Author
There was a problem hiding this comment.
"They all work the same except Update object doesnt't support "Current object" mode"
phrasing check.
I do think its more efficient to talk about all 3 steps on 1 docs page
andy-knock
commented
Feb 10, 2026
|
|
||
| The **Data functions** tab in the workflow builder includes three steps that update data in Knock during a workflow run: **Update user**, **Update tenant**, and **Update object**. They all work the same except Update object doesnt't support "Current object" mode. Use them when you need to change a [user](/concepts/users), [tenant](/concepts/tenants), or [object](/concepts/objects) based on workflow context so that downstream steps, [audiences](/concepts/audiences), or other workflows see the updated data. | ||
|
|
||
| Common use cases include syncing state from your trigger (for example, "last notified at" on a user, approval status on a tenant, or status on an object), making a user eligible for a dynamic audience or [guide](/concepts/guides), updating [preferences](/preferences/overview) or [tenant-level preference defaults](/preferences/tenant-preferences), or storing channel data (for example, a Slack channel id on an object). |
Contributor
Author
There was a problem hiding this comment.
these examples come from the notion doc
https://www.notion.so/knockapp/New-workflow-functions-2c6c5a20997880538f30d460cd5f0304
andy-knock
commented
Feb 10, 2026
|
|
||
| ## Debugging | ||
|
|
||
| You can use the [workflow run logs](/send-notifications/debugging-workflows) to debug these steps. The logs capture the change made by the step so you can verify the pre-state, the properties that were set, and the post-state. |
Contributor
Author
There was a problem hiding this comment.
Edit this to align with the final logging behavior.
andy-knock
changed the title
| section: Designing workflows | ||
| --- | ||
|
|
||
| The **Data functions** tab in the workflow builder includes three steps that update data in Knock during a workflow run: **Update user**, **Update tenant**, and **Update object**. They all work the same except Update object doesnt't support "Current object" mode. Use them when you need to change a [user](/concepts/users), [tenant](/concepts/tenants), or [object](/concepts/objects) based on workflow context so that downstream steps, [audiences](/concepts/audiences), or other workflows see the updated data. |
Contributor
There was a problem hiding this comment.
Suggested change
| The **Data functions** tab in the workflow builder includes three steps that update data in Knock during a workflow run: **Update user**, **Update tenant**, and **Update object**. They all work the same except Update object doesnt't support "Current object" mode. Use them when you need to change a [user](/concepts/users), [tenant](/concepts/tenants), or [object](/concepts/objects) based on workflow context so that downstream steps, [audiences](/concepts/audiences), or other workflows see the updated data. | |
| The **Data functions** tab in the workflow builder includes three steps that update data in Knock during a workflow run: **Update user**, **Update tenant**, and **Update object**. Use them when you need to change a [user](/concepts/users), [tenant](/concepts/tenants), or [object](/concepts/objects) based on workflow context so that downstream steps, [audiences](/concepts/audiences), or other workflows see the updated data. |
I think you can actually leave this out since you mention it below in object-specific section.
|
|
||
| How you specify which entity to update depends on the step type. | ||
|
|
||
| ### Update user and Update tenant |
Contributor
There was a problem hiding this comment.
Feels like you could break these into their own headings so users, tenants, and objects all have an 'on this page' entry.
|
|
||
| In the step editor you can edit properties as a JSON blob or in key-value form. Updated properties are stored in Knock and are available to subsequent workflow steps and to the Management API. | ||
|
|
||
| ### Updating user preferences (Update user only) |
Contributor
There was a problem hiding this comment.
Could nest this under update user section so all that info is self-contained
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.
Description
Add docs for Update User, Update Tenant, Update Object steps
NOTE: I will not ship this PR till we actually launch the feature, only publishing it for review / revision.
Screenshots