Subscriptions Setup

The goss.subscriptions.sendAlerts end point is responsible for processing all subscriptions across all of the subsites defined in the configuration.

First, it retrieves all articles for a subsite that have a creation date within the schedule period set in the configuration.

Next, it collates a list of all unique metadata value IDs related by those articles, then fetches any user objects whose SUBSCRIPTIONS property contains one or more of the IDs in the that list for that subsite.

Finally, it loops through each of the user objects and checks their SUBSCRIPTIONS property against the related metadata values of each article. Any articles that match for that user are added to the body of an email that is then sent to that user.

Return

Once the endpoint has completed, it will return a structure containing the following:

• success - true, or false, indicating whether the end point completed successfully
• error - if present, this specifies the details of any exception thrown
• subsites - An array of the subsites that were processed by the end point, with each element containing arrays for the articles (IDs) and subscribers (object IDs) that were processed for that subsite, along with emails (object IDs) for subscribers who were sent emails

Schedule

We recommend scheduling the sendAlerts end point to run weekly. If you decide to run it more often, you should also change the schedule period in the configuration to match. Running the end point more frequently than the config setting would list the same updates in repeat emails, running it less frequently than the period would skip updates that happened between runs and outside the config setting.