For AI agents: Find a documentation index at https://talkjs.com/llms.txt (full content at https://talkjs.com/llms-full.txt). Get a markdown version of any page by appending .md to its URL path.

CustomData

Store custom metadata on users, conversations, and messages.

View as Markdown

This object is used to store additional metadata on users, conversations and messages.

Example

1{
2 country: "nl",
3 itemId: "720"
4}

Properties

FieldTypeDescription
[key: string]stringAny number of key/value pairs of your choosing to be stored along with the associated resource. You can use custom data for all kinds of purposes, such as customizing a user's email notification text, transmitting contextual user data, or making email login tokens.

Both the key and the value must be strings; arbitrarily deeply nested JSON is not supported.

Used by