Topics

Notifications


In This Guide

Brightspot can send you a notification when certain events occur, such as when someone publishes an asset or completes a translation.


Overview of Brightspot notifications

During the course of a day, thousands of events occur throughout Brightspot. Editors publish assets, comment on assets, complete assignments, edit graphics, and much more. For each event, Brightspot can emit a message, and editors can retrieve those messages over email, text messaging, or other messaging platform.

Because there are so many different types of messages, Brightspot organizes them into the following topics:

  • Assignment Desk—Includes messages about new or updated assignments and pitches.
  • Conversation—Includes messages about conversations containing editors' names.
  • Publish—Includes messages about publishing, such as when an asset is pushed to a web server for visitors to view.
  • Translation—Includes messages about translation jobs, such as when a translation starts, ends, or fails due to an error.
  • Workflow—Includes messages triggered when assets transition through a workflow.

Editors create subscriptions to these topics, specifying for each desired delivery methods. For example—

  • Harrison creates a subscription for publishing articles to the site brightspot.com via text message.
  • Olivia creates a subscription for receiving notifications via email when she is mentioned in a conversation.
  • Alma creates a subscription for translation jobs that fail via browser notification.

The following diagram is an example of the relationship between events, topics, and subscriptions.

Notification overview

Brightspot periodically runs a job that delivers the message to the subscribers using the requested delivery method. Brightspot removes a message from the queue after each subscriber received the message or failed to receive the message after a certain number of attempts. The messages stay in the queue until purged by another job.


Conditions for sending notifications

A subscription’s content filter is a set of criteria Brightspot applies to an event. If the event satisfies the criteria, Brightspot sends a notification. You can have a subscription with multiple content filters as illustrated in the following example.

Multiple content types

Referring to the previous example, Brightspot sends notifications when any of the following conditions are true:

  • An editor publishes an article or gallery to the site Inspire Confidence.
  • An event occurred on an asset you are watching.
  • An editor publishes an audio or video to the site Inspire Innovation.

One of the content filters you can select when creating a subscription is Match All. In this case, Brightspot checks that all of the conditions in the content filter are satisfied before sending a notification.

Multiple all content types

Referring to the previous illustration, Brightspot sends a notification when all of the following are true:

  • The editor is watching the asset.
  • The asset is published simultaneously to the sites Inspire Confidence and Inspire Innovation.
  • The asset is an article.

Integrating a text messaging service

Some editors may want to receive notifications via text messaging. This section describes integrating Twilio as the text messaging service. Integration for other services is similar.

To integrate a text messaging service:

  1. Log in to your Twilio console, and select the account from which you want to send text messages. The account's dashboard appears.
  2. Under Account Info, copy the values for Account SID and Auth Token into a text editor.
    Twilio account info
  3. In a text editor, open the Tomcat configuration file context.xml.
  4. Add lines similar to the following:
    <!-- SMS -->
    <Environment name="dari/defaultSmsProvider" type="java.lang.String" value="twilio" /> 
    <Environment name="dari/smsProvider/twilio/class" type="java.lang.String" value="notifications.TwilioSmsProvider" /> 
    <Environment name="dari/smsProvider/twilio/accountSid" type="java.lang.String" value="putYourAccountIDHere" /> 
    <Environment name="dari/smsProvider/twilio/authToken" type="java.lang.String" value="putYourAuthTokenHere" />
    <Environment name="dari/smsProvider/twilio/defaultFromNumber" type="java.lang.String" value="+12028164833" /> 
    • Specifies the default text messaging configuration as twilio. This configuration appears by default in the Sms Provider Setting Key field in step 8.
    • Specifies the fully qualified class name implementing the text messaging service.
    • Value for the account ID that you copied in step 2.
    • Value for the authentication token that you copied in step 2.
    • Default from number that appears in the recipient’s text message. This number must be one that the SMS service recognizes as authorized to send text messages.
  5. Save and close the configuration file.
  6. Restart the Tomcat server.
  7. In Brightspot, click menu> Admin > Sites & Settings > Sites > Global. The Edit Global widget appears.
  8. Under CMS > Notifications > SMS Settings, do the following:
    1. In the Default From Phone Number field, enter what appears as the "from" number in text messages.
    2. In the Sms Provider Setting Key field, keep the default configuration (twilio as in the above snippet), or enter one of the other configurations.
  9. Click Save.

Sending messages to external services

Brightspot can send messages to external services, such as a listserv or Slack channel. Editors subscribed to those services receive the corresponding messages.

To send messages to external services:

  1. Click menu> Admin > Sites & Settings > Sites > Global.
  2. Click search, and in the search field type System Notifications. A form appears.
  3. Under System Notifications, click add_circle_outline. A form appears.
  4. Under Delivery Methods, click add_circle_outline and select one of the following:

    • Email—In the form that appears, enter the email for the messaging service (such as a listserv address), or create a new one.
    • Microsoft Teams—In the form that appears, select the team and channel.
    • Slack—In the form that appears, select the workspace and channel, or create new ones. Brightspot sends a verification message to the destination.
    • Text—In the form that appears, enter the phone number for the messaging service, or create a new one.

    Repeat to add additional delivery methods.

  5. Under Subscriptions, click add_circle_outline. A form appears.
  6. From the Topic list, select one of the available topics.
  7. Using the following resources, complete the subscription for the selected topic:

  8. Click Save.

Viewing recent notifications

Whenever your subscriptions trigger a notification, Brightspot adds the notification to the Notifications widget—in addition to sending the notification through the subscriptions’ delivery methods. You also receive notifications when one of your subscriptions fails to deliver a message, such as when an email server is down.

Notification widget

The counter in the header lists the number of unread notifications you have. After you open the Notifications widget, the counter resets to zero.

Notification counter

To view recent notifications:

  1. In the header, click notifications_none. The Notifications widget appears.
  2. Click the notification. Brightspot opens the corresponding item in a content edit page.