Skip to main content

Settings

Settings stores the global settings for a given Tenant.

type Settings {
id: ID!
domain: String!
webhooks: WebhookConfiguration!
webhookEvents: [WEBHOOK_EVENT_NAME!]!
staticURI: String
locale: Locale!
live: LiveConfiguration!
moderation: MODERATION_MODE
premoderateAllCommentsSites: [ID!]!
communityGuidelines: CommunityGuidelines!
premodLinksEnable: Boolean
closeCommenting: CloseCommenting!
flattenReplies: Boolean!
customCSSURL: String
customFontsCSSURL: String
disableDefaultFonts: Boolean!
disableCommenting: DisableCommenting!
editCommentWindowLength: Int!
charCount: CharCount!
organization: Organization!
email: EmailConfiguration!
slack: SlackConfiguration!
wordList: WordList!
auth: Auth!
integrations: ExternalIntegrations!
recentCommentHistory: RecentCommentHistoryConfiguration!
reaction: ReactionConfiguration!
featuredBy: Boolean
topCommenter: TopCommenterConfiguration
newCommenter: NewCommenterConfiguration
staff: BadgeConfiguration! @deprecated
badges: BadgeConfiguration!
accountFeatures: CommenterAccountFeatures!
stories: StoryConfiguration!
media: MediaConfiguration!
featureFlags: [FEATURE_FLAG!]!
createdAt: Time!
newCommenters: NewCommentersConfiguration!
premoderateSuspectWords: Boolean!
announcement: Announcement
multisite: Boolean!
rte: RTEConfiguration!
memberBios: Boolean!
amp: Boolean!
forReviewQueue: Boolean!
emailDomainModeration: [EmailDomain!]!
protectedEmailDomains: [String!]!
externalProfileURL: String
embeddedComments: EmbeddedCommentsConfiguration
flairBadges: FlairBadgeConfiguration
dsa: DSAConfiguration!
premoderateEmailAddress: PremoderateEmailAddressConfiguration
inPageNotifications: InPageNotificationsConfiguration
showUnmoderatedCounts: Boolean
}

Fields

Settings.id ● ID! non-null scalar

id is a canonical identifier for this Tenant.

Settings.domain ● String! non-null scalar

domain is the domain that is associated with this Tenant.

Settings.webhooks ● WebhookConfiguration! non-null object

webhooks store the webhook configuration.

Settings.webhookEvents ● [WEBHOOK_EVENT_NAME!]! non-null enum

webhookEvents returns all the events that can trigger webhooks.

Settings.staticURI ● String scalar

staticURI if configured, is the static URI used to serve static files from.

Settings.locale ● Locale! non-null scalar

locale is the specified locale for this Tenant.

Settings.live ● LiveConfiguration! non-null object

live provides configuration options related to live updates for stories on this site.

Settings.moderation ● MODERATION_MODE enum

moderation is the moderation mode for all Stories on the site.

Settings.premoderateAllCommentsSites ● [ID!]! non-null scalar

premoderateAllCommentsSites are the sites that should have all comments premoderated when moderation mode is SPECIFIC_SITES_PRE

Settings.communityGuidelines ● CommunityGuidelines! non-null object

communityGuidelines will be shown in the comments stream.

Settings.premodLinksEnable ● Boolean scalar

premodLinksEnable will put all comments that contain links into premod.

Settings.closeCommenting ● CloseCommenting! non-null object

closeCommenting contains settings related to the automatic closing of commenting on Stories.

Settings.flattenReplies ● Boolean! non-null scalar

flattenReplies when enabled, will cause all replies that would normally be hidden by a "Show more of this conversation" button to be displayed linearly sorted by date.

Settings.customCSSURL ● String scalar

customCSSURL is the URL of the custom CSS used to display on the frontend.

Settings.customFontsCSSURL ● String scalar

customFontsCSSURL is the URL of the custom CSS with @font-face definitions used to display on the frontend.

Settings.disableDefaultFonts ● Boolean! non-null scalar

disableDefaultFonts will turn off font-face loading of Coral's default fonts.

Settings.disableCommenting ● DisableCommenting! non-null object

disableCommenting will disable commenting site-wide.

Settings.editCommentWindowLength ● Int! non-null scalar

editCommentWindowLength is the length of time (in seconds) after a comment is posted that it can still be edited by the author.

Settings.charCount ● CharCount! non-null object

charCount stores the character count moderation settings.

Settings.organization ● Organization! non-null object

organization stores information about the organization behind this specific instance of Coral.

Settings.email ● EmailConfiguration! non-null object

email is the set of credentials and settings associated with the organization.

Settings.slack ● SlackConfiguration! non-null object

slack is the configuration for slack communication

Settings.wordList ● WordList! non-null object

wordList will return a given list of words.

Settings.auth ● Auth! non-null object

auth contains all the settings related to authentication and authorization.

Settings.integrations ● ExternalIntegrations! non-null object

integrations contains all the external integrations that can be enabled.

Settings.recentCommentHistory ● RecentCommentHistoryConfiguration! non-null object

recentCommentHistory is the set of settings related to how automatic pre-moderation is controlled.

Settings.reaction ● ReactionConfiguration! non-null object

reaction specifies the configuration for reactions.

Settings.featuredBy ● Boolean scalar

featuredBy specifies whether or not to display 'Featured by' for featured comments

Settings.topCommenter ● TopCommenterConfiguration object

topCommenter specifies whether or not the feature is enabled to show that commenters with comments featured within the last 10 days are top commenters

Settings.newCommenter ● NewCommenterConfiguration object

newCommenter specifies whether or not the feature is enabled to show that commenters are new and have joined within the last seven days.

Settings.staff ● BadgeConfiguration! deprecated non-null object

DEPRECATED

Use badges instead

staff specifies the configuration for the user badges assigned to users with any role above COMMENTER

Settings.badges ● BadgeConfiguration! non-null object

badges specifies the configuration for the user badges assigned to users with any role above COMMENTER.

Settings.accountFeatures ● CommenterAccountFeatures! non-null object

accountFeatures stores the configuration for commenter account features.

Settings.stories ● StoryConfiguration! non-null object

stories stores the configuration around stories.

Settings.media ● MediaConfiguration! non-null object

media is the configuration media content attached to Comment's.

Settings.featureFlags ● [FEATURE_FLAG!]! non-null enum

featureFlags provides the enabled feature flags.

Settings.createdAt ● Time! non-null scalar

createdAt is the time that the Settings was created at.

Settings.newCommenters ● NewCommentersConfiguration! non-null object

newCommenters is the configuration for how new commenters comments are treated.

Settings.premoderateSuspectWords ● Boolean! non-null scalar

premoderateSuspectWords when enabled will cause any comments that contain suspect words to be sent to pre-moderation to be reviewed by a moderator prior to being presented in stream.

Settings.announcement ● Announcement object

announcement is the currently active Announcement.

Settings.multisite ● Boolean! non-null scalar

multisite is whether multiple sites exist for this tenant.

Settings.rte ● RTEConfiguration! non-null object

rte is the configuration of the Rich-Text-Editor.

Settings.memberBios ● Boolean! non-null scalar

memberBios is whether members can define a bio for their account.

Settings.amp ● Boolean! non-null scalar

amp is whether Accelerated Mobile Pages Support is activated.

Settings.forReviewQueue ● Boolean! non-null scalar

forReviewQueue is whether or not to show the For Review queue in the Moderate tab of the admin. This queue allows moderators to review every flag that has been put on a comment by a user. This feature shall help complying with European Law (European Directive 2000/31/CE).

Settings.emailDomainModeration ● [EmailDomain!]! non-null object

emailDomainModeration is for any special configuration by email domain for moderating accounts, such as banning or always pre-moderating new users at a certain email domain

Settings.protectedEmailDomains ● [String!]! non-null scalar

protectedEmailDomains is the configuration for email domains that are protected from email domain moderation rules such as all accounts banned

Settings.externalProfileURL ● String scalar

externalProfileURL is a string template for a link to a user's external profile.

Settings.embeddedComments ● EmbeddedCommentsConfiguration object

embeddedComments includes the configuration for embedded comments.

Settings.flairBadges ● FlairBadgeConfiguration object

flairBadges specifies the configuration for flair badges, including whether they are enabled and any configured image urls

Settings.dsa ● DSAConfiguration! non-null object

dsa specifies the configuration for the European Union's DSA compliance features and whether they are enabled.

Settings.premoderateEmailAddress ● PremoderateEmailAddressConfiguration object

premoderateEmailAddress is the configuration for finding specific email addresses at sign up and premoderating them according to various rules.

Settings.inPageNotifications ● InPageNotificationsConfiguration object

inPageNotifcations is the configuration for in-page notifications, including whether it's enabled as an option for commenters.

Settings.showUnmoderatedCounts ● Boolean scalar

showUnmoderatedCounts is whether to show the unmoderated comment count in the moderation queues.

Returned By

settings query

Member Of

CreateAnnouncementPayload object ● CreateEmailDomainPayload object ● CreateExternalModerationPhasePayload object ● CreateFlairBadgePayload object ● CreateWebhookEndpointPayload object ● DeactivateSSOSigningSecretPayload object ● DeleteAnnouncementPayload object ● DeleteEmailDomainPayload object ● DeleteFlairBadgePayload object ● DeleteSSOSigningSecretPayload object ● RotateSSOSigningSecretPayload object ● UpdateEmailDomainPayload object ● UpdateSettingsPayload object