Skip to main content

App > Design > Integrations > Communications

Set up SendGrid for transactional and templated email, and WebPurify for profanity filtering

Written by Jason Liang

The App > Design > Integrations > Communications page sets up email and moderation services for your app: SendGrid for transactional and templated email, and WebPurify for profanity filtering.

Each service has its own panel. Click a panel to expand it, turn on Enable, fill in the settings and click Save Changes in that panel. Each panel is saved separately. If you try to leave the page with unsaved changes, you are asked to confirm.

SendGrid

SendGrid is a transactional and marketing email platform. Connecting your own SendGrid account lets brainCloud send your app's emails through it.

  • SendGrid API Key (required): an API key from your SendGrid account with permission to send mail.

  • Default From Address (required): the address emails are sent from. Must be a valid email address, and should be a sender verified in SendGrid.

  • Default From Name (required): the sender name shown to recipients.

  • Default Reply-to Address and Default Reply-to Name (optional): where replies should go, if different from the From address.

Click Test to send a test email to your own portal login address using the values currently on screen, including unsaved changes. If it arrives, your settings are working.

When SendGrid is enabled, all of your app's emails are sent through your SendGrid account using these From and Reply-to details. SendGrid is required for:

  • The Mail service APIs (SendBasicEmail, SendAdvancedEmail, SendAdvancedEmailByAddress and SendAdvancedEmailByAddresses).

  • Templated authentication emails (email verification, password reset, account locked and account deletion) that use SendGrid templates. Simple, non-templated versions of these emails can be sent without SendGrid.

  • Dormant user (User Purge) notice emails.

For a full setup guide, see Email Integration: SendGrid.

WebPurify

WebPurify is a profanity filtering service that supports up to 15 languages, block lists and allow lists, and a range of usage levels. Connecting your WebPurify account enables brainCloud's profanity features.

  • API Key (required when enabled): your API key from the WebPurify Dashboard.

  • Languages: select the languages to filter. You need a WebPurify Enterprise account to filter more than one language. These languages are used by the profanity APIs when a call doesn't specify its own.

  • Automatically filter user names: check player names for profanity when they are set with UpdateName or UpdateProfile. A name that contains profanity is rejected with the error "Name contains profanity".

  • Restrict name check to user's own language: when checking a name, only check the player's own language, if it is one of the selected languages.

  • Restrict text for unsupported languages across ALL languages: when the player's language is unknown or not supported by WebPurify, check the name against all selected languages instead of skipping the check.

The two "Restrict" options only apply to the automatic user name check.

When WebPurify is enabled, you can:

  • Use the Profanity service APIs: ProfanityCheck, ProfanityReplaceText and ProfanityIdentifyBadWords. They are also available from Cloud Code. Without WebPurify, these calls fail.

  • Turn on the profanity filter for Chat in your messaging settings. Chat uses its own language settings, configured there.

Permissions

Write access to this page is required to change these settings. Users with read-only access can view the page, but all controls are disabled.

Did this answer your question?