Notification Service Settings

MPO Version: 1.3.0

Defines the basic notification configuration for the project. This includes the notification options providers for different notification channels such as SMS, email, and push notifications.

interface NotificationServiceSettings = {
  serviceOptions : NotificationServiceOptions;
  smtpSettings : SmtpSettings;
  amazonSNSSettings : AmazonSNSSettings;
  firebaseSettings : FirebaseSettings;
  sendGridSettings : SendGridSettings;
  twilioSettings : TwilioSettings;
  vonageSettings : VonageSettings;
  netGsmSettings : NetGSMSettings;
  oneSignalSettings : OneSignalSettings;
}

NotificationServiceOptions

MPO Version: 1.3.0

Defines the global notification configuration for the project. This includes providers for different notification channels and the list of event-driven notification behaviors triggered by Kafka messages.

interface NotificationServiceOptions = {
  storedNotice : Boolean;
  smsProvider : SmsProvider;
  emailProvider : EmailProvider;
  pushProvider : PushProvider;
}

SmsProvider

Defines valid SMS providers for project-wide notifications.

const SmsProvider = {
  amazonsns: "amazonsns",
  fake: "fake",
  netgsm: "netgsm",
  twilio: "twilio",
  vonage: "vonage",
};

EmailProvider

Defines valid email providers for project-wide notifications.

const EmailProvider = {
  amazonsns: "amazonsns",
  fake: "fake",
  sendgrid: "sendgrid",
  smtp: "smtp",
};

PushProvider

Defines valid push notification providers for project-wide delivery.

const PushProvider = {
  amazonsns: "amazonsns",
  fake: "fake",
  firebase: "firebase",
  onesignal: "onesignal",
};

SmtpSettings

MPO Version: 1.3.0

Defines configuration for using a custom SMTP server to send emails. Mindbricks uses a managed cloud provider by default, but you may configure your own server here.

interface SmtpSettings = {
  useCustomSmptServer : Boolean;
  configuration : SmtpSettingsConfig;
}

SmtpSettingsConfig

MPO Version: 1.3.0

Defines the configuration for a custom SMTP server. This object is used when useCustomSmptServer is set to true. It includes the host, port, authentication, and security details.

interface SmtpSettingsConfig = {
  emailFrom : String;
  emailHost : String;
  emailPort : Integer;
  emailUser : String;
  emailPass : String;
  isSecure : Boolean;
}

AmazonSNSSettings

MPO Version: 1.3.0

Defines configuration for integrating Amazon SNS for messaging and notifications. Mindbricks does not provide a managed SNS setup, so you must supply your own credentials if you choose to use this service.

interface AmazonSNSSettings = {
  useAmazonSNS : Boolean;
  configuration : AmazonSNSSettingsConfig;
}

AmazonSNSSettingsConfig

MPO Version: 1.3.0

Defines the configuration for Amazon SNS. This object is used when useAmazonSNS is set to true. It includes the secret key, access key, and region.

interface AmazonSNSSettingsConfig = {
  secretKey : String;
  accessKey : String;
  region : String;
}

FirebaseSettings

MPO Version: 1.3.0

Defines configuration for using Firebase services. Mindbricks does not include Firebase by default, so this setup is required only if Firebase will be used for messaging or real-time features.

interface FirebaseSettings = {
  useFirebase : Boolean;
  configuration : FirebaseSettingsConfig;
}

FirebaseSettingsConfig

MPO Version: 1.3.0

Defines the configuration for Firebase. This object is used when useFirebase is set to true. It includes the API key for Firebase services.

interface FirebaseSettingsConfig = {
  firebaseKey : String;
}

SendGridSettings

MPO Version: 1.3.0

Defines configuration for integrating SendGrid to send transactional or notification emails. You must register a SendGrid account and provide your API key.

interface SendGridSettings = {
  useSendGrid : Boolean;
  configuration : SendGridSettingsConfig;
}

SendGridSettingsConfig

MPO Version: 1.3.0

Defines the configuration for SendGrid. This object is used when useSendGrid is set to true. It includes the API key and sender email address.

interface SendGridSettingsConfig = {
  sendGridApiKey : String;
  sendGridFromEmail : String;
}

TwilioSettings

MPO Version: 1.3.0

Defines configuration for using Twilio to send SMS or perform voice operations. Mindbricks does not provide a managed Twilio account, so integration must be configured here.

interface TwilioSettings = {
  useTwilio : Boolean;
  configuration : TwilioSettingsConfig;
}

TwilioSettingsConfig

MPO Version: 1.3.0

Defines the configuration for Twilio. This object is used when useTwilio is set to true. It includes the Account SID, authentication token, and sender identity.

interface TwilioSettingsConfig = {
  twilioAccountSid : String;
  twilioAuthToken : String;
  twilioSender : String;
}

VonageSettings

MPO Version: 1.3.0

Defines configuration for integrating Vonage as an SMS provider. Provide credentials for your Vonage account if this service is used.

interface VonageSettings = {
  useVonage : Boolean;
  configuration : VonageSettingsConfig;
}

VonageSettingsConfig

MPO Version: 1.3.0

Defines the configuration for Vonage. This object is used when useVonage is set to true. It includes the token and sender name/number.

interface VonageSettingsConfig = {
  vonageToken : String;
  vonageSender : String;
}

NetGSMSettings

MPO Version: 1.3.0

Defines configuration for using the Turkish SMS provider NetGSM. You must supply your own credentials to use this service in Mindbricks.

interface NetGSMSettings = {
  useNetGSM : Boolean;
  configuration : NetGSMSettingsConfig;
}

NetGSMSettingsConfig

MPO Version: 1.3.0

Defines the configuration for NetGSM. This object is used when useNetGSM is set to true. It includes the username, password, and sender ID.

interface NetGSMSettingsConfig = {
  netGsmUsername : String;
  netGsmPassword : String;
  netGsmSender : String;
}

OneSignalSettings

MPO Version: 1.3.0

Defines configuration for OneSignal push notifications. Mindbricks does not manage OneSignal accounts, so a valid app ID and API key must be provided.

interface OneSignalSettings = {
  useOneSignal : Boolean;
  configuration : OneSignalSettingsConfig;
}

OneSignalSettingsConfig

MPO Version: 1.3.0

Defines the configuration for OneSignal. This object is used when useOneSignal is set to true. It includes the app ID and REST API key.

interface OneSignalSettingsConfig = {
  oneSignalAppId : String;
  oneSignalApiKey : String;
}