Get a notification's details
GET {{baseUrl}}/v1/notifications/:notification_uuid
Upon receiving a notification webhook event, use this endpoint to fetch the notification's details. The notification details include basic suggested content that can help you build notifications in your platform.
Note: partners are responsible for the delivery and any custom state management of notifications in their application. Refer to our partner notification guide for more details.
If the notification UUID is not found, the response will be 404 Not Found. If the notification's supporting data is no longer valid, the response will be 422 Unprocessable Entity.
scope: notifications:read
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
RESPONSES
status: OK
{"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.","status":"open","category":"information_request","actionable":true,"published_at":"2022-01-01T00:00:00.000Z","due_at":"2022-02-01T00:00:00.000Z","resources":[{"entity_type":"Employee","entity_uuid":"21b6f9ce-0ac4-4745-8d8a-127f8c0f00f2"}]}