Added fields to GET a notification's details

We've added two new fields—template_variables and status—to GET /v1/notifications/{notification_uuid}.

Usage

1. Call GET /v1/notifications/{notification_uuid}, which will have a response like the following example:

   JSON

   {
     "uuid": "7b1d0df1-6403-4a06-8768-c1dd7d24d27a",
     "company_uuid": "88f7cca1-dcad-4d20-84db-7fb80303d69f",
     "title": "Action required: Additional information needed to process payroll",
     "message": "If we do not receive this information as soon as possible, your payroll may not be processed on time.",
     "category": "information_request",
     "actionable": true,
     "can_block_payroll": true,
     "published_at": "2022-01-01T00:00:00.000Z",
     "due_at": "2022-02-01T00:00:00.000Z",
     "template_variables": {
       "blocked_task": "Payroll"
     },
     "resources": [
       {
         "entity_type": "Employee",
         "entity_uuid": "21b6f9ce-0ac4-4745-8d8a-127f8c0f00f2"
       }
     ]
   }
   

2. Use the template_variables and status fields:

   • Use template_variables to build your own custom messages and copy. See Partner Notifications Types for the template variables we provide for each notification type.

     For example, you can use the {beneficiary_name}, {amount}, and {company_name} fields in the bank_error.compensation_credit_failure notification to give your users more context when showing them the notification via email or in your in-app UI.

   • Use the read-only status to filter notification messages on your client side, or to display statuses on your UI.