Intro

Channel

Channels are the medium through which you want your notification to be delivered to the end user. Currently Neptune helps you send notifications through following channels:

• Email
• SMS
• Firebase
• Others

But that only suggests half the story, it's not enough if you tell neptune what channel to use, but have to also configure which driver to use.

Driver

Driver is the actual provider you want to use to deliver the notification. Drivers are our integrations into actual providers in the market, and with time we are adding more and more drivers.

The following is the complete list of channels and corresponding drivers we currently have:

channel	driver	Configuration
Email	Mailgun	Email -> Mailgun
Email	SES	Email -> SES
Firebase	Firebase	Firebase
SMS	Digimiles	SMS -> Digimiles

Configuration

Email -> Mailgun

{
  "from": "CompanyName <support@mg.company.com>",
  "domain": "mg.company.com",
  "api_key": "the-secret-key"
}

Email -> SES

{
  "from": "CompanyName <support@mg.company.com>",
  "api_key": "the-api-key",
  "api_secret": "the-api-secret",
  "aws_region": "the-region"
}

Firebase

{
  "type": "service_account",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "client_id": "102...",
  "token_uri": "https://oauth2.googleapis.com/token",
  "project_id": "project...",
  "private_key": "private_key...",
  "client_email": "firebase-adminsdk-..@...",
  "private_key_id": "....",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/...",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs"
}

SMS -> Digimiles

{
  "sender": "usually-a-shortcode-of-6-characters",
  "api_key": "api-key"
}