VANotify
Last Updated:
VANotify is a notifications platform, allowing consumer services to send emails and texts to their users.
Overview and Terminology
Code and issues for the Notification API is stored in this repository.
The Notification API was forked from a repository belonging to the Canadian Digital Service, which in turn was forked from the original project by the British Government Digital Service.
The first use case for the platform is to send confirmation emails for the submission of Form 526ez, from vets-api.
Integration Endpoints
Name | Description | endpoint |
|---|---|---|
Send SMS | Send an SMS notification, providing a recipient phone number and template ID | POST http://{{host}}/v2/notifications/sms |
Send email | Send an email notification, providing a recipient email address and template ID | POST http://{{host}}/v2/notifications/email |
Environments
The Notification API is currently deployed to a development environment on ThoughtWorks' AWS instance, at http://dev-notification-load-balancer-1502931385.us-east-2.elb.amazonaws.com
A staging environment is in the process of being provisioned, and will also be hosted on ThoughtWorks' AWS instance.
The API will be deployed to the VA's infrastructure for production.
Required Configuration
Configuration for the API is stored in config.py, and set using environment variables.
These environment variables are stored in AWS SSM Parameter Store.
Known External Dependencies
The API currently depends on GovDelivery for sending emails, and Twilio for sending SMS.
Outage Status and Maintenance Windows
There are no standard maintenance windows.
Escalation Procedure
Notify the VANotify team using the #va-notify-public slack channel or the contacts below.
Contacts
See this README for updated contacts.
Role | Name | |
|---|---|---|
Product | Paras Shah | |
Product Lead VA Notify | Melanie Jones | |
UX Lead / Researcher | Elissa Folk | |
Software Engineer, VA Notify | Ian Perera | |
Digital Notification SME | Jacob Cheriathundam | |
Tech Lead VA.gov | Nathan Wright |
Help and feedback
Get help from the Platform Support Team in Slack.
Submit a feature idea to the Platform.