Skip to content

GovDelivery TMS API

Jump to bottom
Matthew Thornton edited this page Jul 19, 2024 · 4 revisions

Overview

Whenever we send out email notifications from Caseflow, we interact with a third party API known as the GovDelivery Targeted Messaging System (TMS) which helps deliver and track emails send from the application.

Usage

As of 5/2023 we are reaching out to GovDelivery with four separate types of email notifications, those being:

  1. DispatchMailer
  2. HearingMailer
  3. HearingEmailStatusMailer
  4. MembershipRequestsMailer

Adding a new valid "from" sending address

What is a "from" address?

As of 5/2023 Caseflow is able to utilize two separate "from" addresses, meaning the address that will be shown to users as far as which VA entity has initiated the message. Those addresses are as follows:

  1. For the DispatchMailer, HearingMailer and HearingEmailStatusMailer we are using the same from address: BoardofVeteransAppealsHearings@messages.va.gov
  2. For the MembershipRequestsMailer we are using a VHA specific address: vhabenefitappeals@messages.va.gov

You will note that both email addresses listed utilize the "messages" domain which is important as it is what allows GovDelivery TMS to setup bulk mail delivery functionality on their side

How to add a new valid "from" address

In addition to adding the preferred address in the default from: portion of the mailer, you will need to take additional steps in order for GovDelivery to recognize it as a valid address on their end. GovDelivery is managed by a company called Granicus. Granicus has a page which outlines the steps that are needed in order for their developers to make the proper updates to allow for a new address to be recognized.

The team has received guidance from OIT that they would like to drive future discussions when this process is necessary. In order to get the process started, team leads should reach out to Joshua Tuscher (Joshua.Tuscher@va.gov) who manages the Granicus account for appeals. Joshua can get the process started and can even request an escalation if any delays are experienced.

Be prepared to provide the following account name for the from address(es) to be added under: USVABVA

Clone this wiki locally