Skip to main content

team_profile_change event

The workspace profile fields have been updated

Facts

Required Scopes
No scopes required!
Compatible APIs

Usage info​

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

{
    "token": "XXYYZZ",
    "team_id": "T123ABC456",
    "api_app_id": "A123ABC456",
    "event": {
        "type": "team_profile_change",
        "profile": {
            "fields": [
                {
                    "id": "Xf06054AAA",
                    ...
                },
                ...
            ]
        }
    },
    "type": "event_callback",
    "authed_users": [
        "U123ABC456",
        "U222222222"
    ],
    "event_id": "Ev123ABC456",
    "event_time": 123456789
}

The team_profile_change event is sent to all connections for a workspace when Workspace Admin updates the field definitions in the profile. Only the modified field definitions are included in the payload. Where appropriate, clients should update to reflect new changes immediately.