Update app user metadata

Once you have registered your app user, you can attach a map with key-value pairs which contain additional data about the app user and their behavior.

Update app user metadata by calling the Shake.updateUserMetadata method anywhere in your code after registering the User.

Special keys

Values from these two keys will be presented nicely on the Shake dashboard, so we suggest you use them:

• first_name
• last_name

If you want to notify your users about new chat messages by email, provide the following metadata key:

• email

Updates

Updates to the app user metadata are merged. This allows you to update user metadata in segments from various parts of your app, even when offline.

A common approach developers take is updating generic app user metadata from one place in your code upon every app user change

Javascript

login.js

const onLoggedIn = (user) => {
  const metadata = {
    'first_name': user.firstName,
    'last_name': user.lastName,
    'email': user.email,
    'status': user.status,
  }
  Shake.updateUserMetadata(metadata);
}

Typescript

login.ts

const onLoggedIn = (user: User) => {
  const metadata = {
    'first_name': user.firstName,
    'last_name': user.lastName,
    'email': user.email,
    'status': user.status,
  }
  Shake.updateUserMetadata(metadata);
}

and updating specific app user metadata in their respective contexts:

Javascript

settings.js

const onUserSettingsChanged = (settings) => {
  const metadata = {
    'user_settings': settings.value,
  }
  Shake.updateUserMetadata(metadata);
}

Typescript

settings.ts

const onUserSettingsChanged = (settings: UserSettings) => {
  const metadata = {
    'user_settings': settings.value,
  }
  Shake.updateUserMetadata(metadata);
}

Limitations

The total map size of the app user metadata must not exceed 50 KB. If this validation fails, the update method is dropped with the appropriate console message.

App user metadata vs. Ticket metadata

Track app User metadata to understand and describe your app User better. Examples are:

• First and last name
• App user ID
• Address
• Subscription status
• Date of birth

Use Ticket metadata to attach useful custom data to each ticket. Examples are statuses of various app variables at the moment the ticket is sent:

• Current chat room ID
• List of items currently in a shopping cart
• Task synced true/false
• Number of search results
• List sorted by what
• Video muted true/false