diff --git a/test/asyncapi.md b/test/asyncapi.md deleted file mode 100644 index f52ad3e07..000000000 --- a/test/asyncapi.md +++ /dev/null @@ -1,6393 +0,0 @@ -# Slack Real Time Messaging API 1.0.0 documentation - - - - -## Table of Contents - -* [Connection Details](#servers) -* [Events](#events) - - [Events a client can receive](#events-receive) - - [Events a client can send](#events-send) -* [Messages](#messages) -* [Schemas](#schemas) - - - -## Connection details - - - - - - - - - - - - - - - - - - -
URLSchemeDescription
https://slack.com/api/rtm.connecthttps
- - -## Security - - - - - - - - - - - - - - - - - - - - - - -
TypeInNameSchemeFormatDescription
httpApiKeyquerytoken
- - -## Events - -### Events a client can receive: -#### Hello -First event received upon connection. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - hello
- - - -#### Event #1 -Event received when a connection error happens. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - error
error - object - Any
error.code - number - Any
error.msg - string - Any
- - - -#### Event #2 -The list of accounts a user is signed into has changed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - accounts_changed
- - - -#### Event #3 -A bot user was added. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - bot_added
bot - object - Any
bot.id - string - Any
bot.app_id - string - Any
bot.name - string - Any
bot.icons - object - Any
- - - -#### Event #4 -A bot user was changed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - bot_added
bot - object - Any
bot.id - string - Any
bot.app_id - string - Any
bot.name - string - Any
bot.icons - object - Any
- - - -#### Event #5 -A channel was archived. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_archive
channel - string - Any
user - string - Any
- - - -#### Event #6 -A channel was created. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_created
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
channel.creator - string - Any
- - - -#### Event #7 -A channel was deleted. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_deleted
channel - string - Any
- - - -#### Event #8 -Bulk updates were made to a channel's history. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_history_changed
latest - string - Any
ts - string - Any
event_ts - string - Any
- - - -#### Event #9 -You joined a channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_joined
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
channel.creator - string - Any
- - - -#### Event #10 -You left a channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_left
channel - string - Any
- - - -#### Event #11 -Your channel read marker was updated. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_marked
channel - string - Any
ts - string - Any
- - - -#### Event #12 -A channel was renamed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_rename
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
- - - -#### Event #13 -A channel was unarchived. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_unarchive
channel - string - Any
user - string - Any
- - - -#### Event #14 -A slash command has been added or changed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - commands_changed
event_ts - string - Any
- - - -#### Event #15 -Do not Disturb settings changed for the current user. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - dnd_updated
user - string - Any
dnd_status - object - Any
dnd_status.dnd_enabled - boolean - Any
dnd_status.next_dnd_start_ts - number - Any
dnd_status.next_dnd_end_ts - number - Any
dnd_status.snooze_enabled - boolean - Any
dnd_status.snooze_endtime - number - Any
- - - -#### Event #16 -Do not Disturb settings changed for a member. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - dnd_updated_user
user - string - Any
dnd_status - object - Any
dnd_status.dnd_enabled - boolean - Any
dnd_status.next_dnd_start_ts - number - Any
dnd_status.next_dnd_end_ts - number - Any
- - - -#### Event #17 -The workspace email domain has changed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - email_domain_changed
email_domain - string - Any
event_ts - string - Any
- - - -#### Event #18 -A custom emoji has been removed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - emoji_changed
subtype - string - remove
names - array(string) - Any
event_ts - string - Any
- - - -#### Event #19 -A custom emoji has been added. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - emoji_changed
subtype - string - add
name - string - Any
value - string - Any
event_ts - string - Any
- - - -#### Event #20 -A file was changed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_change
file_id - string - Any
file - object - Any
file.id - string - Any
- - - -#### Event #21 -A file comment was added. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_comment_added
comment - - Any
file_id - string - Any
file - object - Any
file.id - string - Any
- - - -#### Event #22 -A file comment was deleted. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_comment_deleted
comment - string - Any
file_id - string - Any
file - object - Any
file.id - string - Any
- - - -#### Event #23 -A file comment was edited. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_comment_edited
comment - - Any
file_id - string - Any
file - object - Any
file.id - string - Any
- - - -#### Event #24 -A file was created. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_created
file_id - string - Any
file - object - Any
file.id - string - Any
- - - -#### Event #25 -A file was deleted. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_deleted
file_id - string - Any
event_ts - string - Any
- - - -#### Event #26 -A file was made public. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_public
file_id - string - Any
file - object - Any
file.id - string - Any
- - - -#### Event #27 -A file was shared. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_shared
file_id - string - Any
file - object - Any
file.id - string - Any
- - - -#### Event #28 -A file was unshared. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_unshared
file_id - string - Any
file - object - Any
file.id - string - Any
- - - -#### Event #29 -The server intends to close the connection soon. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - goodbye
- - - -#### Event #30 -A private channel was archived. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_archive
channel - string - Any
- - - -#### Event #31 -You closed a private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_close
user - string - Any
channel - string - Any
- - - -#### Event #32 -Bulk updates were made to a private channel's history. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_history_changed
latest - string - Any
ts - string - Any
event_ts - string - Any
- - - -#### Event #33 -You joined a private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_joined
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
channel.creator - string - Any
- - - -#### Event #34 -You left a private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_left
channel - string - Any
- - - -#### Event #35 -A private channel read marker was updated. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_marked
channel - string - Any
ts - string - Any
- - - -#### Event #36 -You opened a private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_open
user - string - Any
channel - string - Any
- - - -#### Event #37 -A private channel was renamed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_rename
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
- - - -#### Event #38 -A private channel was unarchived. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_unarchive
channel - string - Any
user - string - Any
- - - -#### Event #39 -You closed a DM. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - im_close
channel - string - Any
user - string - Any
- - - -#### Event #40 -A DM was created. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - im_created
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
channel.creator - string - Any
user - string - Any
- - - -#### Event #41 -A direct message read marker was updated. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - im_marked
channel - string - Any
ts - string - Any
- - - -#### Event #42 -You opened a DM. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - im_open
channel - string - Any
user - string - Any
- - - -#### Event #43 -You manually updated your presence. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - manual_presence_change
presence - string - Any
- - - -#### Event #44 -A user joined a public or private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - member_joined_channel
user - string - Any
channel - string - Any
channel_type - string - C, G
team - string - Any
inviter - string - Any
- - - -#### Event #45 -A message was sent to a channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - message
user - string - Any
channel - string - Any
text - string - Any
ts - string - Any
attachments - array(object) - Any
attachments.fallback - string - Any
attachments.color - string - Any
attachments.pretext - string - Any
attachments.author_name - string - Any
attachments.author_link - string - Any
attachments.author_icon - string - Any
attachments.title - string - Any
attachments.title_link - string - Any
attachments.text - string - Any
attachments.fields - array(object) - Any
attachments.fields.title - string - Any
attachments.fields.value - string - Any
attachments.fields.short - boolean - Any
attachments.image_url - string - Any
attachments.thumb_url - string - Any
attachments.footer - string - Any
attachments.footer_icon - string - Any
attachments.ts - number - Any
edited - object - Any
edited.user - string - Any
edited.ts - string - Any
- - - - -### Events a client can send: -#### Event #0 -A message was sent to a channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
id - number - Any
type - string - message
channel - string - Any
text - string - Any
- - - - -## Messages - -### hello -First event received upon connection. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - hello
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "hello" -} -``` - -### connectionError -Event received when a connection error happens. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - error
error - object - Any
error.code - number - Any
error.msg - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "error", - "error": { - "code": 0, - "msg": "string" - } -} -``` - -### accountsChanged -The list of accounts a user is signed into has changed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - accounts_changed
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "accounts_changed" -} -``` - -### botAdded -A bot user was added. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - bot_added
bot - object - Any
bot.id - string - Any
bot.app_id - string - Any
bot.name - string - Any
bot.icons - object - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "bot_added", - "bot": { - "id": "string", - "app_id": "string", - "name": "string", - "icons": { - "property1": "string", - "property2": "string" - } - } -} -``` - -### botChanged -A bot user was changed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - bot_added
bot - object - Any
bot.id - string - Any
bot.app_id - string - Any
bot.name - string - Any
bot.icons - object - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "bot_added", - "bot": { - "id": "string", - "app_id": "string", - "name": "string", - "icons": { - "property1": "string", - "property2": "string" - } - } -} -``` - -### channelArchive -A channel was archived. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_archive
channel - string - Any
user - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "channel_archive", - "channel": "string", - "user": "string" -} -``` - -### channelCreated -A channel was created. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_created
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
channel.creator - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "channel_created", - "channel": { - "id": "string", - "name": "string", - "created": 0, - "creator": "string" - } -} -``` - -### channelDeleted -A channel was deleted. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_deleted
channel - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "channel_deleted", - "channel": "string" -} -``` - -### channelHistoryChanged -Bulk updates were made to a channel's history. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_history_changed
latest - string - Any
ts - string - Any
event_ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "channel_history_changed", - "latest": "string", - "ts": "string", - "event_ts": "string" -} -``` - -### channelJoined -You joined a channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_joined
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
channel.creator - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "channel_joined", - "channel": { - "id": "string", - "name": "string", - "created": 0, - "creator": "string" - } -} -``` - -### channelLeft -You left a channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_left
channel - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "channel_left", - "channel": "string" -} -``` - -### channelMarked -Your channel read marker was updated. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_marked
channel - string - Any
ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "channel_marked", - "channel": "string", - "ts": "string" -} -``` - -### channelRename -A channel was renamed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_rename
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "channel_rename", - "channel": { - "id": "string", - "name": "string", - "created": 0 - } -} -``` - -### channelUnarchive -A channel was unarchived. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - channel_unarchive
channel - string - Any
user - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "channel_unarchive", - "channel": "string", - "user": "string" -} -``` - -### commandsChanged -A slash command has been added or changed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - commands_changed
event_ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "commands_changed", - "event_ts": "string" -} -``` - -### dndUpdated -Do not Disturb settings changed for the current user. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - dnd_updated
user - string - Any
dnd_status - object - Any
dnd_status.dnd_enabled - boolean - Any
dnd_status.next_dnd_start_ts - number - Any
dnd_status.next_dnd_end_ts - number - Any
dnd_status.snooze_enabled - boolean - Any
dnd_status.snooze_endtime - number - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "dnd_updated", - "user": "string", - "dnd_status": { - "dnd_enabled": true, - "next_dnd_start_ts": 0, - "next_dnd_end_ts": 0, - "snooze_enabled": true, - "snooze_endtime": 0 - } -} -``` - -### dndUpdatedUser -Do not Disturb settings changed for a member. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - dnd_updated_user
user - string - Any
dnd_status - object - Any
dnd_status.dnd_enabled - boolean - Any
dnd_status.next_dnd_start_ts - number - Any
dnd_status.next_dnd_end_ts - number - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "dnd_updated_user", - "user": "string", - "dnd_status": { - "dnd_enabled": true, - "next_dnd_start_ts": 0, - "next_dnd_end_ts": 0 - } -} -``` - -### emailDomainChanged -The workspace email domain has changed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - email_domain_changed
email_domain - string - Any
event_ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "email_domain_changed", - "email_domain": "string", - "event_ts": "string" -} -``` - -### emojiRemoved -A custom emoji has been removed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - emoji_changed
subtype - string - remove
names - array(string) - Any
event_ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "emoji_changed", - "subtype": "remove", - "names": [ - "string" - ], - "event_ts": "string" -} -``` - -### emojiAdded -A custom emoji has been added. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - emoji_changed
subtype - string - add
name - string - Any
value - string - Any
event_ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "emoji_changed", - "subtype": "add", - "name": "string", - "value": "http://example.com", - "event_ts": "string" -} -``` - -### fileChange -A file was changed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_change
file_id - string - Any
file - object - Any
file.id - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "file_change", - "file_id": "string", - "file": { - "id": "string" - } -} -``` - -### fileCommentAdded -A file comment was added. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_comment_added
comment - - Any
file_id - string - Any
file - object - Any
file.id - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "file_comment_added", - "comment": null, - "file_id": "string", - "file": { - "id": "string" - } -} -``` - -### fileCommentDeleted -A file comment was deleted. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_comment_deleted
comment - string - Any
file_id - string - Any
file - object - Any
file.id - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "file_comment_deleted", - "comment": "string", - "file_id": "string", - "file": { - "id": "string" - } -} -``` - -### fileCommentEdited -A file comment was edited. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_comment_edited
comment - - Any
file_id - string - Any
file - object - Any
file.id - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "file_comment_edited", - "comment": null, - "file_id": "string", - "file": { - "id": "string" - } -} -``` - -### fileCreated -A file was created. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_created
file_id - string - Any
file - object - Any
file.id - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "file_created", - "file_id": "string", - "file": { - "id": "string" - } -} -``` - -### fileDeleted -A file was deleted. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_deleted
file_id - string - Any
event_ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "file_deleted", - "file_id": "string", - "event_ts": "string" -} -``` - -### filePublic -A file was made public. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_public
file_id - string - Any
file - object - Any
file.id - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "file_public", - "file_id": "string", - "file": { - "id": "string" - } -} -``` - -### fileShared -A file was shared. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_shared
file_id - string - Any
file - object - Any
file.id - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "file_shared", - "file_id": "string", - "file": { - "id": "string" - } -} -``` - -### fileUnshared -A file was unshared. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - file_unshared
file_id - string - Any
file - object - Any
file.id - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "file_unshared", - "file_id": "string", - "file": { - "id": "string" - } -} -``` - -### goodbye -The server intends to close the connection soon. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - goodbye
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "goodbye" -} -``` - -### groupArchive -A private channel was archived. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_archive
channel - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "group_archive", - "channel": "string" -} -``` - -### groupClose -You closed a private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_close
user - string - Any
channel - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "group_close", - "user": "string", - "channel": "string" -} -``` - -### groupHistoryChanged -Bulk updates were made to a private channel's history. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_history_changed
latest - string - Any
ts - string - Any
event_ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "group_history_changed", - "latest": "string", - "ts": "string", - "event_ts": "string" -} -``` - -### groupJoined -You joined a private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_joined
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
channel.creator - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "group_joined", - "channel": { - "id": "string", - "name": "string", - "created": 0, - "creator": "string" - } -} -``` - -### groupLeft -You left a private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_left
channel - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "group_left", - "channel": "string" -} -``` - -### groupMarked -A private channel read marker was updated. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_marked
channel - string - Any
ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "group_marked", - "channel": "string", - "ts": "string" -} -``` - -### groupOpen -You opened a private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_open
user - string - Any
channel - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "group_open", - "user": "string", - "channel": "string" -} -``` - -### groupRename -A private channel was renamed. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_rename
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "group_rename", - "channel": { - "id": "string", - "name": "string", - "created": 0 - } -} -``` - -### groupUnarchive -A private channel was unarchived. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - group_unarchive
channel - string - Any
user - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "group_unarchive", - "channel": "string", - "user": "string" -} -``` - -### imClose -You closed a DM. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - im_close
channel - string - Any
user - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "im_close", - "channel": "string", - "user": "string" -} -``` - -### imCreated -A DM was created. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - im_created
channel - object - Any
channel.id - string - Any
channel.name - string - Any
channel.created - number - Any
channel.creator - string - Any
user - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "im_created", - "channel": { - "id": "string", - "name": "string", - "created": 0, - "creator": "string" - }, - "user": "string" -} -``` - -### imMarked -A direct message read marker was updated. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - im_marked
channel - string - Any
ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "im_marked", - "channel": "string", - "ts": "string" -} -``` - -### imOpen -You opened a DM. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - im_open
channel - string - Any
user - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "im_open", - "channel": "string", - "user": "string" -} -``` - -### manualPresenceChange -You manually updated your presence. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - manual_presence_change
presence - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "manual_presence_change", - "presence": "string" -} -``` - -### memberJoinedChannel -A user joined a public or private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - member_joined_channel
user - string - Any
channel - string - Any
channel_type - string - C, G
team - string - Any
inviter - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "member_joined_channel", - "user": "string", - "channel": "string", - "channel_type": "C", - "team": "string", - "inviter": "string" -} -``` - -### memberLeftChannel -A user left a public or private channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - member_left_channel
user - string - Any
channel - string - Any
channel_type - string - C, G
team - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "member_left_channel", - "user": "string", - "channel": "string", - "channel_type": "C", - "team": "string" -} -``` - -### message -A message was sent to a channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
type - string - message
user - string - Any
channel - string - Any
text - string - Any
ts - string - Any
attachments - array(object) - Any
attachments.fallback - string - Any
attachments.color - string - Any
attachments.pretext - string - Any
attachments.author_name - string - Any
attachments.author_link - string - Any
attachments.author_icon - string - Any
attachments.title - string - Any
attachments.title_link - string - Any
attachments.text - string - Any
attachments.fields - array(object) - Any
attachments.fields.title - string - Any
attachments.fields.value - string - Any
attachments.fields.short - boolean - Any
attachments.image_url - string - Any
attachments.thumb_url - string - Any
attachments.footer - string - Any
attachments.footer_icon - string - Any
attachments.ts - number - Any
edited - object - Any
edited.user - string - Any
edited.ts - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "type": "message", - "user": "string", - "channel": "string", - "text": "string", - "ts": "string", - "attachments": [ - { - "fallback": "string", - "color": "string", - "pretext": "string", - "author_name": "string", - "author_link": "http://example.com", - "author_icon": "http://example.com", - "title": "string", - "title_link": "http://example.com", - "text": "string", - "fields": [ - { - "title": "string", - "value": "string", - "short": true - } - ], - "image_url": "http://example.com", - "thumb_url": "http://example.com", - "footer": "string", - "footer_icon": "http://example.com", - "ts": 0 - } - ], - "edited": { - "user": "string", - "ts": "string" - } -} -``` - -### outgoingMessage -A message was sent to a channel. - - - - -#### Payload - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
id - number - Any
type - string - message
channel - string - Any
text - string - Any
- - -##### Example of payload _(generated)_ - -```json -{ - "id": 0, - "type": "message", - "channel": "string", - "text": "string" -} -``` - - -## Schemas - -#### attachment - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionAccepted values
fallback - string - Any
color - string - Any
pretext - string - Any
author_name - string - Any
author_link - string - Any
author_icon - string - Any
title - string - Any
title_link - string - Any
text - string - Any
fields - array(object) - Any
fields.title - string - Any
fields.value - string - Any
fields.short - boolean - Any
image_url - string - Any
thumb_url - string - Any
footer - string - Any
footer_icon - string - Any
ts - number - Any
- -##### Example _(generated)_ - -```json -{ - "fallback": "string", - "color": "string", - "pretext": "string", - "author_name": "string", - "author_link": "http://example.com", - "author_icon": "http://example.com", - "title": "string", - "title_link": "http://example.com", - "text": "string", - "fields": [ - { - "title": "string", - "value": "string", - "short": true - } - ], - "image_url": "http://example.com", - "thumb_url": "http://example.com", - "footer": "string", - "footer_icon": "http://example.com", - "ts": 0 -} -```