GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security
Changelog
These docs are for v2023-09-01. Click to read the latest docs for v2024-04-01.
added

Added resources array to Partner Notification System

We've added a resources (metadata) array to the partner notification payload.

If a notification is relevant to specific employees or contractors, their UUIDs will be included in the resources array in the notification payload. This can be useful in determining who to notify about a particular notification. In addition, depending on the notification, other relevant UUIDs may also be included – like the UUID of an affected bank account or payroll. This can be used to provide further supplemental information to the end user.

Review our Partner Notifications Types table to see the resource entity types for each notification category.

Example Payload

{
  "uuid": "86e785b3-37a1-40ed-94e4-3cedd3f2fc90",
  "company_uuid": "88f7cca1-dcad-4d20-84db-7fb80303d69f",
  "title": "Tax Forms are now available for %[Quarter] for Review",
  "message": "Filings were submitted successfully and are now available.",
  "category": "forms_filed",
  "actionable": false,
  "published_at": "2022-01-01T00:00:00.000Z",
  "resources": [
    {
      "entity_type": "Employee",
      "entity_uuid": "98a85b2-3ab1-55ed-24d3-abc80303d788"
    }
  ]
}