Skip to main content

hello event

The client has successfully connected to the server

Facts

Required Scopes
No scopes required!
Compatible APIs

Usage info​

The hello event is sent when a connection is opened to the message server.

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

{
    "token": "XXYYZZ",
    "team_id": "T123ABC456",
    "api_app_id": "A123ABC456",
    "event": {
        "type": "hello"
    },
    "type": "event_callback",
    "authed_users": [
        "U123ABC456",
        "U222222222"
    ],
    "event_id": "Ev123ABC456",
    "event_time": 123456789
}

This allows a client to confirm the connection has been correctly opened.