reference-examples-slack-rtm-asyncapi.yml.json

{"asyncapi":"3.1.0","id":"wss://wss-primary.slack.com/websocket","info":{"title":"Slack Real Time Messaging API","version":"1.0.0"},"servers":{"production":{"host":"slack.com","protocol":"https","protocolVersion":"1.1","pathname":"/api/rtm.connect","security":[{"$ref":"#/components/securitySchemes/token"}]}},"channels":{"root":{"address":"/","messages":{"accountsChanged":{"$ref":"#/components/messages/accountsChanged"},"botAdded":{"$ref":"#/components/messages/botAdded"},"botChanged":{"$ref":"#/components/messages/botChanged"},"channelArchive":{"$ref":"#/components/messages/channelArchive"},"channelCreated":{"$ref":"#/components/messages/channelCreated"},"channelDeleted":{"$ref":"#/components/messages/channelDeleted"},"channelHistoryChanged":{"$ref":"#/components/messages/channelHistoryChanged"},"channelJoined":{"$ref":"#/components/messages/channelJoined"},"channelLeft":{"$ref":"#/components/messages/channelLeft"},"channelMarked":{"$ref":"#/components/messages/channelMarked"},"channelRename":{"$ref":"#/components/messages/channelRename"},"channelUnarchive":{"$ref":"#/components/messages/channelUnarchive"},"commandsChanged":{"$ref":"#/components/messages/commandsChanged"},"connectionError":{"$ref":"#/components/messages/connectionError"},"dndUpdated":{"$ref":"#/components/messages/dndUpdated"},"dndUpdatedUser":{"$ref":"#/components/messages/dndUpdatedUser"},"emailDomainChanged":{"$ref":"#/components/messages/emailDomainChanged"},"emojiAdded":{"$ref":"#/components/messages/emojiAdded"},"emojiRemoved":{"$ref":"#/components/messages/emojiRemoved"},"fileChange":{"$ref":"#/components/messages/fileChange"},"fileCommentAdded":{"$ref":"#/components/messages/fileCommentAdded"},"fileCommentDeleted":{"$ref":"#/components/messages/fileCommentDeleted"},"fileCommentEdited":{"$ref":"#/components/messages/fileCommentEdited"},"fileCreated":{"$ref":"#/components/messages/fileCreated"},"fileDeleted":{"$ref":"#/components/messages/fileDeleted"},"filePublic":{"$ref":"#/components/messages/filePublic"},"fileShared":{"$ref":"#/components/messages/fileShared"},"fileUnshared":{"$ref":"#/components/messages/fileUnshared"},"goodbye":{"$ref":"#/components/messages/goodbye"},"groupArchive":{"$ref":"#/components/messages/groupArchive"},"groupClose":{"$ref":"#/components/messages/groupClose"},"groupHistoryChanged":{"$ref":"#/components/messages/groupHistoryChanged"},"groupJoined":{"$ref":"#/components/messages/groupJoined"},"groupLeft":{"$ref":"#/components/messages/groupLeft"},"groupMarked":{"$ref":"#/components/messages/groupMarked"},"groupOpen":{"$ref":"#/components/messages/groupOpen"},"groupRename":{"$ref":"#/components/messages/groupRename"},"groupUnarchive":{"$ref":"#/components/messages/groupUnarchive"},"hello":{"$ref":"#/components/messages/hello"},"imClose":{"$ref":"#/components/messages/imClose"},"imCreated":{"$ref":"#/components/messages/imCreated"},"imMarked":{"$ref":"#/components/messages/imMarked"},"imOpen":{"$ref":"#/components/messages/imOpen"},"manualPresenceChange":{"$ref":"#/components/messages/manualPresenceChange"},"memberJoinedChannel":{"$ref":"#/components/messages/memberJoinedChannel"},"message":{"$ref":"#/components/messages/message"},"outgoingMessage":{"$ref":"#/components/messages/outgoingMessage"}}}},"operations":{"receiveOutgoingMessage":{"action":"receive","channel":{"$ref":"#/channels/root"},"messages":[{"$ref":"#/channels/root/messages/outgoingMessage"}]},"sendMessages":{"action":"send","channel":{"$ref":"#/channels/root"},"messages":[{"$ref":"#/channels/root/messages/hello"},{"$ref":"#/channels/root/messages/connectionError"},{"$ref":"#/channels/root/messages/accountsChanged"},{"$ref":"#/channels/root/messages/botAdded"},{"$ref":"#/channels/root/messages/botChanged"},{"$ref":"#/channels/root/messages/channelArchive"},{"$ref":"#/channels/root/messages/channelCreated"},{"$ref":"#/channels/root/messages/channelDeleted"},{"$ref":"#/channels/root/messages/channelHistoryChanged"},{"$ref":"#/channels/root/messages/channelJoined"},{"$ref":"#/channels/root/messages/channelLeft"},{"$ref":"#/channels/root/messages/channelMarked"},{"$ref":"#/channels/root/messages/channelRename"},{"$ref":"#/channels/root/messages/channelUnarchive"},{"$ref":"#/channels/root/messages/commandsChanged"},{"$ref":"#/channels/root/messages/dndUpdated"},{"$ref":"#/channels/root/messages/dndUpdatedUser"},{"$ref":"#/channels/root/messages/emailDomainChanged"},{"$ref":"#/channels/root/messages/emojiRemoved"},{"$ref":"#/channels/root/messages/emojiAdded"},{"$ref":"#/channels/root/messages/fileChange"},{"$ref":"#/channels/root/messages/fileCommentAdded"},{"$ref":"#/channels/root/messages/fileCommentDeleted"},{"$ref":"#/channels/root/messages/fileCommentEdited"},{"$ref":"#/channels/root/messages/fileCreated"},{"$ref":"#/channels/root/messages/fileDeleted"},{"$ref":"#/channels/root/messages/filePublic"},{"$ref":"#/channels/root/messages/fileShared"},{"$ref":"#/channels/root/messages/fileUnshared"},{"$ref":"#/channels/root/messages/goodbye"},{"$ref":"#/channels/root/messages/groupArchive"},{"$ref":"#/channels/root/messages/groupClose"},{"$ref":"#/channels/root/messages/groupHistoryChanged"},{"$ref":"#/channels/root/messages/groupJoined"},{"$ref":"#/channels/root/messages/groupLeft"},{"$ref":"#/channels/root/messages/groupMarked"},{"$ref":"#/channels/root/messages/groupOpen"},{"$ref":"#/channels/root/messages/groupRename"},{"$ref":"#/channels/root/messages/groupUnarchive"},{"$ref":"#/channels/root/messages/imClose"},{"$ref":"#/channels/root/messages/imCreated"},{"$ref":"#/channels/root/messages/imMarked"},{"$ref":"#/channels/root/messages/imOpen"},{"$ref":"#/channels/root/messages/manualPresenceChange"},{"$ref":"#/channels/root/messages/memberJoinedChannel"},{"$ref":"#/channels/root/messages/message"}]}},"components":{"schemas":{"attachment":{"type":"object","properties":{"author_icon":{"type":"string","format":"uri"},"author_link":{"type":"string","format":"uri"},"author_name":{"type":"string"},"color":{"type":"string"},"fallback":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"short":{"type":"boolean"},"title":{"type":"string"},"value":{"type":"string"}}}},"footer":{"type":"string"},"footer_icon":{"type":"string","format":"uri"},"image_url":{"type":"string","format":"uri"},"pretext":{"type":"string"},"text":{"type":"string"},"thumb_url":{"type":"string","format":"uri"},"title":{"type":"string"},"title_link":{"type":"string","format":"uri"},"ts":{"type":"number"}}}},"messages":{"accountsChanged":{"payload":{"type":"object","properties":{"type":{"type":"string","enum":["accounts_changed"]}}},"summary":"The list of accounts a user is signed into has changed."},"botAdded":{"payload":{"type":"object","properties":{"bot":{"type":"object","properties":{"app_id":{"type":"string"},"icons":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"string"},"name":{"type":"string"}}},"type":{"type":"string","enum":["bot_added"]}}},"summary":"A bot user was added."},"botChanged":{"payload":{"type":"object","properties":{"bot":{"type":"object","properties":{"app_id":{"type":"string"},"icons":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"string"},"name":{"type":"string"}}},"type":{"type":"string","enum":["bot_added"]}}},"summary":"A bot user was changed."},"channelArchive":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["channel_archive"]},"user":{"type":"string"}}},"summary":"A channel was archived."},"channelCreated":{"payload":{"type":"object","properties":{"channel":{"type":"object","properties":{"created":{"type":"number"},"creator":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}},"type":{"type":"string","enum":["channel_created"]}}},"summary":"A channel was created."},"channelDeleted":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["channel_deleted"]}}},"summary":"A channel was deleted."},"channelHistoryChanged":{"payload":{"type":"object","properties":{"event_ts":{"type":"string"},"latest":{"type":"string"},"ts":{"type":"string"},"type":{"type":"string","enum":["channel_history_changed"]}}},"summary":"Bulk updates were made to a channel's history."},"channelJoined":{"payload":{"type":"object","properties":{"channel":{"type":"object","properties":{"created":{"type":"number"},"creator":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}},"type":{"type":"string","enum":["channel_joined"]}}},"summary":"You joined a channel."},"channelLeft":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["channel_left"]}}},"summary":"You left a channel."},"channelMarked":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"ts":{"type":"string"},"type":{"type":"string","enum":["channel_marked"]}}},"summary":"Your channel read marker was updated."},"channelRename":{"payload":{"type":"object","properties":{"channel":{"type":"object","properties":{"created":{"type":"number"},"id":{"type":"string"},"name":{"type":"string"}}},"type":{"type":"string","enum":["channel_rename"]}}},"summary":"A channel was renamed."},"channelUnarchive":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["channel_unarchive"]},"user":{"type":"string"}}},"summary":"A channel was unarchived."},"commandsChanged":{"payload":{"type":"object","properties":{"event_ts":{"type":"string"},"type":{"type":"string","enum":["commands_changed"]}}},"summary":"A slash command has been added or changed."},"connectionError":{"payload":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number"},"msg":{"type":"string"}}},"type":{"type":"string","enum":["error"]}}},"summary":"Event received when a connection error happens."},"dndUpdated":{"payload":{"type":"object","properties":{"dnd_status":{"type":"object","properties":{"dnd_enabled":{"type":"boolean"},"next_dnd_end_ts":{"type":"number"},"next_dnd_start_ts":{"type":"number"},"snooze_enabled":{"type":"boolean"},"snooze_endtime":{"type":"number"}}},"type":{"type":"string","enum":["dnd_updated"]},"user":{"type":"string"}}},"summary":"Do not Disturb settings changed for the current user."},"dndUpdatedUser":{"payload":{"type":"object","properties":{"dnd_status":{"type":"object","properties":{"dnd_enabled":{"type":"boolean"},"next_dnd_end_ts":{"type":"number"},"next_dnd_start_ts":{"type":"number"}}},"type":{"type":"string","enum":["dnd_updated_user"]},"user":{"type":"string"}}},"summary":"Do not Disturb settings changed for a member."},"emailDomainChanged":{"payload":{"type":"object","properties":{"email_domain":{"type":"string"},"event_ts":{"type":"string"},"type":{"type":"string","enum":["email_domain_changed"]}}},"summary":"The workspace email domain has changed."},"emojiAdded":{"payload":{"type":"object","properties":{"event_ts":{"type":"string"},"name":{"type":"string"},"subtype":{"type":"string","enum":["add"]},"type":{"type":"string","enum":["emoji_changed"]},"value":{"type":"string","format":"uri"}}},"summary":"A custom emoji has been added."},"emojiRemoved":{"payload":{"type":"object","properties":{"event_ts":{"type":"string"},"names":{"type":"array","items":{"type":"string"}},"subtype":{"type":"string","enum":["remove"]},"type":{"type":"string","enum":["emoji_changed"]}}},"summary":"A custom emoji has been removed."},"fileChange":{"payload":{"type":"object","properties":{"file":{"type":"object","properties":{"id":{"type":"string"}}},"file_id":{"type":"string"},"type":{"type":"string","enum":["file_change"]}}},"summary":"A file was changed."},"fileCommentAdded":{"payload":{"type":"object","properties":{"comment":{},"file":{"type":"object","properties":{"id":{"type":"string"}}},"file_id":{"type":"string"},"type":{"type":"string","enum":["file_comment_added"]}}},"summary":"A file comment was added."},"fileCommentDeleted":{"payload":{"type":"object","properties":{"comment":{"type":"string"},"file":{"type":"object","properties":{"id":{"type":"string"}}},"file_id":{"type":"string"},"type":{"type":"string","enum":["file_comment_deleted"]}}},"summary":"A file comment was deleted."},"fileCommentEdited":{"payload":{"type":"object","properties":{"comment":{},"file":{"type":"object","properties":{"id":{"type":"string"}}},"file_id":{"type":"string"},"type":{"type":"string","enum":["file_comment_edited"]}}},"summary":"A file comment was edited."},"fileCreated":{"payload":{"type":"object","properties":{"file":{"type":"object","properties":{"id":{"type":"string"}}},"file_id":{"type":"string"},"type":{"type":"string","enum":["file_created"]}}},"summary":"A file was created."},"fileDeleted":{"payload":{"type":"object","properties":{"event_ts":{"type":"string"},"file_id":{"type":"string"},"type":{"type":"string","enum":["file_deleted"]}}},"summary":"A file was deleted."},"filePublic":{"payload":{"type":"object","properties":{"file":{"type":"object","properties":{"id":{"type":"string"}}},"file_id":{"type":"string"},"type":{"type":"string","enum":["file_public"]}}},"summary":"A file was made public."},"fileShared":{"payload":{"type":"object","properties":{"file":{"type":"object","properties":{"id":{"type":"string"}}},"file_id":{"type":"string"},"type":{"type":"string","enum":["file_shared"]}}},"summary":"A file was shared."},"fileUnshared":{"payload":{"type":"object","properties":{"file":{"type":"object","properties":{"id":{"type":"string"}}},"file_id":{"type":"string"},"type":{"type":"string","enum":["file_unshared"]}}},"summary":"A file was unshared."},"goodbye":{"payload":{"type":"object","properties":{"type":{"type":"string","enum":["goodbye"]}}},"summary":"The server intends to close the connection soon."},"groupArchive":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["group_archive"]}}},"summary":"A private channel was archived."},"groupClose":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["group_close"]},"user":{"type":"string"}}},"summary":"You closed a private channel."},"groupHistoryChanged":{"payload":{"type":"object","properties":{"event_ts":{"type":"string"},"latest":{"type":"string"},"ts":{"type":"string"},"type":{"type":"string","enum":["group_history_changed"]}}},"summary":"Bulk updates were made to a private channel's history."},"groupJoined":{"payload":{"type":"object","properties":{"channel":{"type":"object","properties":{"created":{"type":"number"},"creator":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}},"type":{"type":"string","enum":["group_joined"]}}},"summary":"You joined a private channel."},"groupLeft":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["group_left"]}}},"summary":"You left a private channel."},"groupMarked":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"ts":{"type":"string"},"type":{"type":"string","enum":["group_marked"]}}},"summary":"A private channel read marker was updated."},"groupOpen":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["group_open"]},"user":{"type":"string"}}},"summary":"You opened a private channel."},"groupRename":{"payload":{"type":"object","properties":{"channel":{"type":"object","properties":{"created":{"type":"number"},"id":{"type":"string"},"name":{"type":"string"}}},"type":{"type":"string","enum":["group_rename"]}}},"summary":"A private channel was renamed."},"groupUnarchive":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["group_unarchive"]},"user":{"type":"string"}}},"summary":"A private channel was unarchived."},"hello":{"payload":{"type":"object","properties":{"type":{"type":"string","enum":["hello"]}}},"summary":"First event received upon connection."},"imClose":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["im_close"]},"user":{"type":"string"}}},"summary":"You closed a DM."},"imCreated":{"payload":{"type":"object","properties":{"channel":{"type":"object","properties":{"created":{"type":"number"},"creator":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}},"type":{"type":"string","enum":["im_created"]},"user":{"type":"string"}}},"summary":"A DM was created."},"imMarked":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"ts":{"type":"string"},"type":{"type":"string","enum":["im_marked"]}}},"summary":"A direct message read marker was updated."},"imOpen":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"type":{"type":"string","enum":["im_open"]},"user":{"type":"string"}}},"summary":"You opened a DM."},"manualPresenceChange":{"payload":{"type":"object","properties":{"presence":{"type":"string"},"type":{"type":"string","enum":["manual_presence_change"]}}},"summary":"You manually updated your presence."},"memberJoinedChannel":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"channel_type":{"type":"string","enum":["C","G"]},"inviter":{"type":"string"},"team":{"type":"string"},"type":{"type":"string","enum":["member_joined_channel"]},"user":{"type":"string"}}},"summary":"A user joined a public or private channel."},"memberLeftChannel":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"channel_type":{"type":"string","enum":["C","G"]},"team":{"type":"string"},"type":{"type":"string","enum":["member_left_channel"]},"user":{"type":"string"}}},"summary":"A user left a public or private channel."},"message":{"payload":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/attachment"}},"channel":{"type":"string"},"edited":{"type":"object","properties":{"ts":{"type":"string"},"user":{"type":"string"}}},"text":{"type":"string"},"ts":{"type":"string"},"type":{"type":"string","enum":["message"]},"user":{"type":"string"}}},"summary":"A message was sent to a channel."},"outgoingMessage":{"payload":{"type":"object","properties":{"channel":{"type":"string"},"id":{"type":"number"},"text":{"type":"string"},"type":{"type":"string","enum":["message"]}}},"summary":"A message was sent to a channel."}},"securitySchemes":{"token":{"type":"httpApiKey","name":"token","in":"query"}}}}