Payload for VA Notify - department-of-veterans-affairs/caseflow GitHub Wiki

Payload

The payload that is generated and sent to VA Notify consists of the following:

• participant_id
• template_name
• appeal_id
• appeal_type
• status

Participant ID is a unique value used to identify the Appellant.

Template Name indicates the event that the appellant is being notified of (eg. Hearing Scheduled).

Appeal ID is the unique value used to identify the Appeal. This value is a string that refers to an appeal's UUID if it is an AMA Appeal or Vacol's ID if it is a Legacy Appeal. These two types of IDs are readily identifiable. UUID's consist of numbers, letters, and dashes. Vacol's IDs only have numbers.

Appeal Type indicates if the Appeal is an AMA Appeal or a Legacy Appeal. AMA Appeals have a value of 'Appeal'. Legacy Appeals have a value of 'LegacyAppeal'.

Status indicates if the payload was generated successfully. If all parts of the payload where found, then the status would have a value of 'Success'. If the appellant could not be found, then the status would have a value of 'No claimant'. If the appellant's participant id could not be found, then the status would have a value of 'No participant_id'.

The payload is initially generated as a Ruby object called VANotifySendMessageTemplate. This class is located within app/models/vanotify/va_notify_send_message_template.rb. This object is built using two parameters. The first parameter is message_attributes, which is a hash consisting of the participant_id, appeal_id, appeal_type, and status. The second parameter is template_name.

This payload will then get sent to the SendNotificationJob

Check here if you want to see an overview of the process