Skip to main content

Slack

With the Slack integration, you can do the following:

  • Search for and import files from your Slack workspaces into Brightspot.
  • Receive notifications from Brightspot to your Slack account.

This section describes how to configure the integration with Brightspot.

Including Slack in a Brightspot build

The following table lists the dependencies to include in your build configuration.

ArtifactDescription
com.psddev:slackSupplies the core classes and settings for adding Slack workspaces to Brightspot. This artifact is inherited as a required dependency by the following artifacts, so you need to explicitly include it only if customizing the Slack integration.
com.psddev:slack-notificationAdds support for delivering CMS notifications via Slack.
com.psddev:slack-searchAdds Slack files as a federated search type.

Runtime prerequisites

  • Developer configuration

    • Mandatory: None. The standard subclasses of SlackApiRequest provide methods for searching and downloading Slack files, and for sending notifications through Slack.
    • Optional: Developers can provide additional interactions, such as requesting specific data from alternative API endpoints with different scopes. Extend SlackApiRequest, and use the provided methods such as doApiGetRequest and doApiPostRequest.
  • Ops configuration—Configure a redirect URL, client ID and secret, and bot tokens. For details, see Installing with OAuth.

  • CMS configuration—Configure the site interfacing with Slack. For details, see Configuring the Slack integration.

See also: