Skip to content

auto-update(docs) - feat(runtime): writable user profile fields (name, pictureUrl, properties, attributes) #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
charmenta wants to merge 1 commit into
base: master
Choose a base branch
from
Open

auto-update(docs) - feat(runtime): writable user profile fields (name, pictureUrl, properties, attributes) #497

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions adk/conversations/state.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,4 +214,25 @@ import { bot, user } from "@botpress/runtime"

const botId = bot.id
const userId = user.id
const userId = user.id
```

## User profile

In addition to state and tags, the `user` object exposes writable profile fields: `name`, `pictureUrl`, `properties`, and `attributes`. Changes are saved automatically at the end of the request.

```typescript
import { user } from "@botpress/runtime"

user.name = "Alice"
user.pictureUrl = "https://example.com/avatar.png"
user.properties.tier = "pro"
user.attributes.source = "webchat"
```

The `createdAt` and `updatedAt` timestamps are read-only:

```typescript
const created = user.createdAt
const updated = user.updatedAt
```
Loading