Toggle menu

Subscriptions Setup

End Points Overview

As well as the Subscriptions Setup - Scheduled End Point to send emails, Subscriptions uses the following, all in the goss.subscriptions namespace.

form.deleteObject

This will delete a single SUBSCRIPTION object, specified by either the object's ID, or the email address of the user who's object it is, and the subsite to which they're subscribed.

form.getObject

This will retrieve a single SUBSCRIPTION object, specified by either the object's ID, or the email address of the user who's object it is, and the subsite to which they're subscribed.

form.getSubscribable

This will return a complete array of all metadata value IDs to which the user can subscribe for a specified subsite.

It is taken from the configuration, organised by groups and properties, and is used primarily to populate the checkbox groups for topics on the front-end form.

form.updateObject

This will create a new SUBSCRIPTION object for a user or update an existing one (if a non-zero object ID is provided as a parameter).

schedule.getNewArticles

This will retrieve all recently created articles for the specified subsite. Articles will be returned if they were created within the schedule period defined in the configuration.

schedule.getSubscriptions

This will retrieve all SUBSCRIPTION objects for a specified list of metadata value IDs and subsite. Objects will be returned if one or more of the IDs in the list is found in the object's SUBSCRIPTIONS list property.

Last modified on 22 January 2026