Skip to main content

pref_change event

You have updated your preferences

Facts

Required Scopes
No scopes required!
Compatible APIs

Usage info

This example includes both the event wrapper and the event structure for the pref_change event.

{
"token": "XXYYZZ",
"team_id": "T123ABC456",
"api_app_id": "A123ABC456",
"event": {
"type": "pref_change",
"name": "messages_theme",
"value": "dense"
},
"type": "event_callback",
"authed_users": [
"U123ABC456",
"U222222222"
],
"event_id": "Ev123ABC456",
"event_time": 123456789
}

The pref_change event is sent to all connections for a user when a user preference is changed. Clients should update to reflect new changes immediately.