Documentation Changelog
This changelog lists documentation changes made to the Apex SDK for Slack (Beta) Developer Guide.
July 3, 2023
This documentation changes are new for July 3, 2023.
- The
UserMappingclass is new for theSlacknamespace. - Added a note that four Slack.App class methods have been deprecated and includes an alternative recommendation.
May 11, 2023
These documentation changes are new for May 11, 2023.
- Added new documentation for Slack Multi-Org Management feature.
April 17, 2023
These documentation changes are new for April 17, 2023.
- Added new documentation for Slack Mass User Provisioning.
- Added new documentation to support Moving Orgs & Sandbox Refreshes.
February 23, 2023
These documentation changes are new for February 23, 2023.
- The
SLACKPACKAGINGfeature isn’t required when packaging Slack apps.
February 7, 2023
These documentation changes are new for February 7, 2023.
- Added new flow functionality by using Slack buttons to trigger Flows. 🆕
January 23, 2023
These documentation changes are new for January 11, 2023.
- Dependent fields, picklists, and packaging are now available.
January 11, 2023
These documentation changes are new for January 11, 2023.
- Added new slash command functionality to trigger flows.
- Added
allowUnauthenticatedUsersmethod in ActionDispatcher.
Apex
These classes are new for the Slack namespace.
SharedChannelInviteAcceptedEventSharedChannelInviteApprovedEventSharedChannelInviteDeclinedEventSharedChannelInviteReceivedEvent
December 13, 2022
These documentation changes are new for December 13, 2022.
- Added a limitation about API users in Considerations and Limitations.
November 04, 2022
These documentation changes are new for November 04, 2022.
- Updated reference documentation for TestHarness.User() and TestHarness.Team.
- Add a section clarifying test client overrides an example.
- Added test example to overwrite the botclient using the TestHarness
- New class added for the
Slacknamespace.TestHarness.File
These classes are new for the Slack namespace.
October 20, 2022
These documentation changes are new for October 20, 2022.
- Salesforce SDK for Slack now available in Beta.
September 29, 2022
The following documentation changes are new for September 29, 2022.
- Updated the select component example in an Actions component.
September 15, 2022
These documentation changes are new for September 15, 2022.
- Updated the
Fileclass.
August 23, 2022
The following documentation changes are new for August 23, 2022.
- Removed Slack Components Date Time Picker warning. Now supports multiple time zones.
July 13, 2022
These documentation changes are new for July 13, 2022.
- Added a section clarifying user client usage.
July 5, 2022
These documentation changes are new for July 5, 2022.
- Updated the allowed components in an Actions component.
May 6, 2022
The following documentation changes are new for May 6, 2022.
- Added a section about enabling channel localization. 🆕
- Updated the Slack and Salesforce User Locales section.
- Clarified that expressions are case-sensitive.
- Added a section about deprecated events.
- Added a section about register a message event handler using the channel types and subtypes.
- Removed
getBotClientForEnterprise()andgetUserClientForEnterprise()methods as Enterprise Grid isn’t yet supported.
April 29, 2022
These documentation changes are new for April 29, 2022.
- Added a limitation about scopes in Considerations and Limitations.
- Added a section about Scope Limitations.
April 25, 2022
The following documentation changes are new for April 25, 2022.
- Clarified and added examples for the Select and External Select components.
- Added data provider examples for Slack.Option and Slack.OptionGroup.
April 7, 2022
The following documentation changes are new for April 7, 2022.
- Added information about enabling the Slack for Salesforce Beta.
- Added an updated version of the sample app.
- Added information about event subscriptions.
- Added event examples.
- Added reference documentation for TestHarness.executeEvent() and
File.Headersclass. - Added a section for creating permissions for a Slack app.
- Added new methods like
getHttpResponseHeaders()andsetHttpResponseHeaders()to many of the*Responseand*Requestclasses.
March 28, 2022
The following documentation changes are new for March 28, 2022.
- Added a section about localization limitations.
- Added a note about Slack’s block limit for surface components.
- Updated the Apex SDK for Slack considerations and limitations.
- Updated the character limits for modals and homepage views.
March 25, 2022
The following documentation changes are new for March 25, 2022.
- Added a section about Slack’s rate limit.
- Added information on
.Builderclasses to call out required methods. - Updated the
properties.textdescription for the section layout component to call outmrkdwnusage. - Fixed a minor error to include a url for all
slash_commandsentries in the manifest example for the sample app. - Fixed the
properties.confirmdescription for the select component.
March 18, 2022
The following documentation changes are new for March 18, 2022.
- Added a note about localization support for Slack’s
(optional)input field label. - Added an updated version of the sample app.
March 14, 2022
The following documentation changes are new for March 14, 2022.
- Salesforce Slack SDK is now Apex SDK for Slack. The dev guide has been updated to reflect the product name change.
- The TestHarness.Field class has been removed to follow the deprecation of the field component.
March 10, 2022
The following documentation changes are new for March 10, 2022.
- Added a note about limited time zone support for the date picker, time picker, and date time picker components.
March 8, 2022
The following documentation changes are new for March 8, 2022.
- Added documentation for the test harness framework and the Apex
TestHarnessclass. - Added an updated version of the sample app.
- Added the
datasourcecomposition object for data providers. - Added a note about limited support for expressions.
- Updated Use Custom Labels to denote support for the
{!label.key}expression.
Mar 2, 2022
These documentation changes are new for Mar 2, 2022.
- Added a section about action signing.
Feb 24, 2022
These documentation changes are new for Feb 24, 2022.
- Added a note that the field component has been deprecated and recommend an alternative way to render field values.
Feb 9, 2022
These documentation changes are new for Feb 9, 2022.
- Added localization information.
- Added input validation.
- Fixed trailing space errors in XML code blocks. The extra space resulted in errors when pushing with SFDX.
Feb 3, 2022
These documentation changes are new for Feb 3, 2022.
- Foyer is now Salesforce Slack SDK. The dev guide has been updated to reflect the product name change.
- Added a section Delete a User Mapping.
Feb 1, 2022
The following documentation changes are new for Feb 1, 2022.
Apex
These classes are new for the Slack namespace.
BillableInfoBotIconsBotProfileBotProfile.IconsCallCallParticipantChannelConversationErrorResponseMetadataFieldFileFile.AddressFile.PinnedInfoFile.ShareDetailFile.SharesFileCommentIntegrationLogLatestLatest.EditedLoginMatchedItemMatchedItem.AddressMatchedItem.OtherItemMessageMessage.EditedMessage.IconsMessage.MessageItemMessage.MessageRootMessage.MessageRootReplyPagingPurposeReactionReactionsListRequestReactionsListResponseReactionsListResponse.IconsReactionsListResponse.ItemReactionsListResponse.MessageReactionsListResponse.MessageRootReplyReactionsListResponse.UserProfileReminderResponseMetadataSearchResultSearchResult.PaginationStarsListRequestStarsListResponseStarsListResponse.CommentStarsListResponse.EditedStarsListResponse.ItemStarsListResponse.MessageStarsListResponse.MessageRootReplyTeamTeam.ProfileTeam.ProfileOptionsTeamIconTopicUserUser.EnterpriseUserUser.FieldUser.ProfileUsergroupWarningResponseMetadataWorkflowStepInputWorkflowStepOutput
These classes were deleted.
FilesUploadResponseFilesUploadRequestUsersSetPhotoRequestUsersSetPhotoResponse
These classes have changes.
AppsEventAuthorizationsListRequest.Builder has changed.
- The
maxLimit(maxLimit)method has been renamed tolimitValue(limitValue).
AppsEventAuthorizationsListResponse has new methods.
getAuthorizations()setAuthorizations(authorizations)
AuthTeamsListRequest has changed.
- The
maxLimit(maxLimit)method has been renamed tolimitValue(limitValue).
AuthTeamsListResponse has new methods.
getTeams()getResponseMetadata()setTeams(teams)setResponseMetadata(responseMetadata)
BotClient has changed.
reactionsList(req)has been added.filesUpload(req)has been removed.
BotsInfoResponse has new methods.
getIcons()setIcons(icons)
CallsAddRequest.Builder has a new method.
users(users)
CallsAddResponse has new methods.
getCall()getReponseMetadata()setCall(call)setResponseMetadata(responseMetadata)
CallsEndResponse has new methods.
getCall()getResponseMetadata()setCall(call)setResponseMetadata(responseMetadata)
CallsInfoResponse has new methods.
getCall()getResponseMetadata()setCall(call)setResponseMetadata(responseMetadata)
CallsParticipantsAddRequest.Builder has a new method.
users(users)
CallsParticipantsAddResponse has new methods.
getCall()getResponseMetadata()setCall(call)setResponseMetadata(responseMetadata)
CallsParticipantsRemoveRequest.Builder has a new method.
users(users)
CallsParticipantsRemoveResponse has new methods.
getCall()getResponseMetadata()setCall(call)setResponseMetadata(responseMetadata)
CallsUpdateResponse has new methods.
getCall()getResponseMetadata()setCall(call)setResponseMetadata(responseMetadata)
ChatPostMessageReponse has new methods.
getResponseMetadata()getMessage()setResponseMetadata(responseMetadata)setMessage(message)
ChatScheduleMessageResponse.ScheduledMessage has new methods.
getBotProfile()setBotProfile(botProfile)
ChatScheduledMessagesListRequest has changed.
- The
maxLimit(maxLimit)method has been renamed tolimitValue(limitValue).
ChatScheduledMessagesListResponse has new methods.
getScheduledMessages()getResponseMetadata()setScheduledMessages(scheduledMessages)setResponseMetadata(responseMetadata)
ChatUpdateResponse has new methods.
getMessage()setMessage(message)
ConversationsCreateResponse has new methods.
getChannel()setChannel(channel)
ConversationsHistoryRequest.Builder has changed.
- The
maxLimit(maxLimit)method has been renamed tolimitValue(limitValue).
ConversationsHistoryResponse has new methods.
getMessages()getResponseMetadata()setMessages(messages)setResponseMetadata(responseMetadata)
ConversationsInfoResponse has new methods.
getChannel()setChannel(channel)
ConversationsInviteResponse has new methods.
getChannel()getErrors()setChannel(channel)setErrors(errors)
ConversationsJoinResponse has new methods.
getChannel()getResponseMetadata()setChannel()setResponseMetadata(responseMetadata)
ConversationsListRequest has changed.
- The
maxLimit(maxLimit)method has been renamed tolimitValue(limitValue).
ConversationsListRequest.Builder has a new method.
types(types)
ConversationsListResponse has new methods.
getChannels()getResponseMetadata()setChannels()setResponseMetadata(responseMetadata)
ConversationsMarkResponse has new methods.
getResponseMetadata()setResponseMetadata(responseMetadata)
ConversationsMembersRequest has changed.
- The
maxLimit(maxLimit)method has been renamed tolimitValue(limitValue).
ConversationsMembersResponse has new methods.
getResponseMetadata()setResponseMetadata(responseMetadata)
ConversationsOpenResponse has new methods.
getChannel()setChannel(channel)
ConversationsRenameResponse has new methods.
getChannel()setChannel(channel)
ConversationsRepliesRequest has changed.
- The
maxLimit(maxLimit)method has been renamed tolimitValue(limitValue).
ConversationsRepliesResponse has new methods.
getMessages()getResponseMetadata()setMessages(messages)setResponseMetadata(responseMetadata)
ConversationsSetPurposeResponse has new methods.
getChannel()setChannel(channel)
ConversationsSetTopicResponse has new methods.
getChannel()setChannel(channel)
DndTeamInfoResponse has new methods.
getUsers()setUsers(users)
FilesInfoResponse has new methods.
getFile()setFile(file)
FilesListReponse has new methods.
getFiles()getPaging()setFiles(files)setPaging(paging)
FilesRemoteAddResponse has new methods.
getFile()setFile(file)
FilesRemoteInfoResponse has new methods.
getFile()setFile(file)
FilesRemoteListRequest has changed.
- The
maxLimit(maxLimit)method has been renamed tolimitValue(limitValue).
FilesRemoteListResponse has new methods.
getFiles()getResponseMetadata()setFiles(files)setResponseMetadata(metadata)
FilesRemoteShareResponse has new methods.
getFile()setFile(file)
FilesRemoteUpdateResponse has new methods.
getFile()setFile(file)
FilesRevokePublicURLResponse has new methods.
getFile()setFile(file)
FilesSharedPublicURLResponse has new methods.
getFile()setFile(file)
PinsAddResponse has new methods.
getResponseMetadata()setResponseMetadata(responseMetadata)
PinsListReponse has new methods.
getItems()setItems(items)
PinsListResponse.MessageItem has new methods.
getComment()getFile()getMessage()setComment(comment)setFile(file)setMessage(message)
ReactionsGetResponse.Message has new methods.
getBotProfile()getReactions()setBotProfile(botProfile)setReactions(reactions)
RemindersAddRequest has changed.
- The
atTime(atTime)method has been renamed totimeValue(timeValue).
RemindersAddResponse has new methods.
getReminder()setReminder(reminder)
RemindersInfoResponse has new methods.
getReminder()setReminder(reminder)
RemindersListResponse has new methods.
getReminders()setReminders(reminders)
SearchAllRequest has changed.
- The
sortType(sortType)method has been renamed tosortValue(sortValue).
SearchAllResponse has new methods.
getMessages()getFiles()setMessages(messages)setFiles(files)
SearchFilesRequest has changed.
- The
sortType(sortType)method has been renamed tosortValue(sortValue).
SearchFilesResponse has new methods.
getFiles()setFiles(files)
SearchMessagesRequest has changed.
- The
sortType(sortType)method has been renamed tosortValue(sortValue).
SearchMessagesResponse has new methods.
getMessages()setMessages(messages)
TeamAccessLogsResponse has new methods.
getLogins()getPaging()setLogins(logins)setPaging(paging)
TeamBillableInfoResponse has new methods.
getBillableInfo()setBillableInfo(billableInfo)
TeamInfoResponse has new methods.
getTeam()setTeam()
TeamIntegrationLogsResponse has new methods.
getLogs()getPaging()setLogs(logs)setPaging(paging)
UserClient has new methods.
reactionsList(req)starsList(req)
UsergroupsCreateResponse has new methods.
getUsergroup()setUsergroup(usergroup)
UsergroupsDisableResponse has new methods.
getUsergroup()setUsergroup(usergroup)
UsergroupsEnableResponse has new methods.
getUsergroup()setUsergroup(usergroup)
UsergroupsListResponse has new methods.
getUsergroups()setUsergroups(usergroups)
UsergroupsUpdateResponse has new methods.
getUsergroup()setUsergroup(usergroup)
UsergroupsUsersUpdateResponse has new methods.
getUsergroup()setUsergroup(usergroup)
UsersConversationsRequest has changed.
- The
maxLimit(maxLimit)method has been renamed tolimitValue(limitValue).
UsersConversationsRequest.Builder has a new method.
types(types)
UsersConversationsResponse has new methods.
getChannels()getResponseMetadata()setChannels(channels)setResponseMetadata(responseMetadata)
UsersInfoResponse has new methods.
getUser()setUser(user)
UsersListRequest has changed.
- The
maxLimit(maxLimit)method has been renamed tolimitValue(limitValue).
UsersListResponse has new methods.
getMembers()getResponseMetadata()setMembers(members)setResponseMetadata(responseMetadata)
UsersLookupByEmailResponse has new methods.
getUser()setUser(user)
ViewsOpenResponse has new methods.
getResponseMetadata()setResponseMetadata(responseMetadata)
ViewsPublishResponse has new methods.
getResponseMetadata()setResponseMetadata(responseMetadata)
ViewsPushResponse has new methods.
getResponseMetadata()setResponseMetadata(responseMetadata)
ViewsUpdateResponse has new methods.
getResponseMetadata()setResponseMetadata(responseMetadata)
WorkflowsUpdateStepRequest has new methods.
inputs(inputs)outputs(outputs)
January 24, 2022
These documentation changes are new for January 24, 2022.
- Updated Data Providers to add support for the Select component to use
List<Slack.Option>andList<Slack.OptionGroup>. - Renamed the Implement the External Select Component doc and updated the URL to Work with Options.
January 14, 2022
These documentation changes are new for January 14, 2022.
-
Removed the
labelproperty from the checkbox group and radio group examples. -
Added an updated version of the sample app.
-
Added User Permissions and Roles to provide an overview on user mapping between Slack and Salesforce.
-
Updated Org Connections to include steps for user-mapping removal and a list of connection errors.
-
Updated the
request_urlandredirect_urlvalues in the example manifests on these pages.
December 20, 2021 (Spring '22 Preview)
These documentation changes are new for December 20, 2021.
Asset Checks
Added Asset Access to explain how Apex SDK for Slack validates access to an asset across namespaces.
Apex
Added examples to:
Events
Added information about events, and added an example of how to respond to the app_home_opened event.
Expressions
Added information about label expressions and formula expressions.
Packaging
Added information and basic guidelines about packaging Slack apps.
Permission Scopes
Added information about scopes and how to determine which scopes to use for an app.
View Definitions
- Added Onboarding with App Home to include examples of how to onboard users using the
app_home_openedevent. - Added a note that views aren’t cached.
Beta Feature