Go to Slack

app_home_opened event

User clicked into your App Home

Compatibility: Events API


{ 
    "type": "app_home_opened",
    "user": "U061F7AUR",
    "channel": "D0LAN2Q65",
    "event_ts": "1515449522000016",
    "tab": "home",
    "view": { 
        "id": "VPASKP233",
        "team_id": "T21312902",
        "type": "home",
        "blocks": [ 
           ...
        ],
        "private_metadata": "",
        "callback_id": "",
        "state":{ 
            ...
        },
        "hash":"1231232323.12321312",
        "clear_on_close": false,
        "notify_on_close": false,
        "root_view_id": "VPASKP233",
        "app_id": "A21SDS90",
        "external_id": "",
        "app_installed_team_id": "T21312902",
        "bot_id": "BSDKSAO2"
    }
}

This app event notifies your app when a user has entered the App Home.

Your Slack app must have a bot user configured and installed to use this event.

If the user opens a tab within the App Home, the event payload for this event will reference that in the tab field. If they opened a Home tab, a view field will also be included, containing the current state of that Home tab, including the list of blocks, and various pieces of metadata.

Use the app_home_opened event to begin a friendly onboarding flow from your app, a whimsical welcome message, or a deep-dive into a detailed dialog. Since the app_home_opened event is only sent to your app when a user has already clicked on your app, you can rest assured that your attentions are welcome.

Note: app_home_opened events are sent each time a user enters into the App Home space. Verify that this is the first interaction between a user and your app before triggering your onboarding flow.

app_home_opened events are just like other message events sent over the Events API, but their type indicates app_home_opened.

Learn more about using app_home_opened for onboarding.

Events API compatibility

Subscribe to this event via the Events API.

Events of this type will be wrapped in metadata when sent via the Events API.

Unavailable in the RTM API

This event type is compatible only with the Events API.