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 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.

Setting up a text message notification configuration

You can configure Brightspot to send text messages. The following sections describe integrating Twilio as the text messaging service. Integration for other services is similar.

Step 1: Acquire SMS API credentials:

This section provides the basic steps to acquire an SMS API key from Twilio. Acquiring API credentials for other messaging services is similar.

  1. In your browser, go to https://www.twilio.com/ and click Get a free API key.
  2. In the Sign up for free page, enter your account information and then click Get Started.

    Twilio signup form

  3. In the verification page, enter your phone number and click Verify via SMS.

    Twilio prompt for sending SMS verification

  4. In the following response page, enter the verification code you received from Twilio and click Submit.

    Prompt from twilio to enter a verification code

  5. Fill out any subsequent forms until you get to the dashboard.
  6. In the dashboard’s upper-right corner, click Show API Credentials.

    Twilio show API credentials

  7. Copy the values for ACCOUNT SID and AUTH TOKEN into a text editor.

Step 2: Provision originating numbers:

In this step, you provision phone numbers from which Twilio can send text messages.

  1. Navigate to the Twilio dashboard, and click Manage Numbers. The Phone Numbers Dashboard appears.

    Twilio phone numbers dashboard

  2. Click Get Started, and in the next page click Get your first Twilio phone number. A widget appears.

    Twilio widget with a suggested phone number

    Referring to the previous illustration, the Twilio phone number is (202) 816-4833.

  3. Click Choose this Number. A confirmation widget appears.

    Twilio confirmation widget

  4. Copy the phone number into a text editor. Referring to the previous illustration, the phone number you copy is +12028164833.

Step 3: Configure Dari for text messaging:
In this step, you configure Dari to send text messages using the API credentials you acquired in Step 1: Acquire SMS API credentials and the phone number you acquired in Step 2: Provision originating numbers.

  1. In a text editor, open the Tomcat configuration file context.xml.
  2. Add the following lines:
    <!-- 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.
    • Specifies the fully qualified class name implementing the text messaging service.
    • Values for the API’s account ID and token that you acquired in Step 1.
    • Specifies the 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, and is the same one you created in Step 2.
  3. Save and close the configuration file.
  4. Restart the Tomcat server.

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.
    • 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.