Skip to main content

star_added event

A member has saved an item for later or starred an item

Facts

Required Scopes
Compatible APIs

Usage info​

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

{
    "token": "XXYYZZ",
    "team_id": "T123ABC456",
    "api_app_id": "A123ABC456",
    "event": {
        "type": "star_added",
        "user": "U123ABC456",
        "item": {
            ...
        },
        "event_ts": "1360782804.083113"
    },
    "type": "event_callback",
    "authorizations": [
        {
            "team_id": "T123ABC456",
            "user_id": "U123ABC456",
            "is_bot": false,
            "is_enterprise_install": false,
        }
    ],
    "event_id": "Ev123ABC456",
    "event_time": 123456789
}

When an item was starred, the star_added event was sent to all connected clients for the authenticated user who starred the item.

See the stars.list method for details of the structure of the item property.