Skip to main content

channel_shared event

A channel has been shared with an external workspace

Facts

Required Scopes
Compatible APIs

Usage info​

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

{
    "token": "XXYYZZ",
    "team_id": "T123ABC456",
    "api_app_id": "A123ABC456",
    "event": {
        "type": "channel_shared",
        "connected_team_id": "E163Q94DX",
        "channel": "C123ABC456",
        "event_ts": "1561064063.001100"
    },
    "type": "event_callback",
    "authed_users": [
        "U123ABC456",
        "U222222222"
    ],
    "event_id": "Ev123ABC456",
    "event_time": 123456789
}

The channel_shared event is sent to all event subscriptions when a new shared channel is created or a channel is converted into a shared channel. It's also triggered when an external workspace is added to an existing shared channel.

The connected_team_id value is the team ID of the workspace that has joined the channel. Note that this ID may start with E, indicating that it is the ID of the organization that has been removed from the channel.

The channel value is the ID for the public or private channel.

This event is supported as a bot user subscription in the Events API. Workspace event subscriptions are also available for tokens holding at least one of the channels:read or groups:read scopes. Which events your app will receive depends on the scopes and their context. For instance, you'll only receive channel_shared events for private channels if your app has the groups:read permission.