A notification is an event that should be communicated to a user. Check has a Notifications API to capture events that should be communicated to an end user. Partners may build product experiences using the Notifications API, such as push notifications or in-product banners.
Check will offer direct communications to users for all notification topics. However, some partners will prefer to send communications themselves.
{
"id": "ntf_MrFrw0F82NSJjyw10Erk",
"topic": "ready_for_payroll",
"company": "com_zH8Gq33iBkFj5o0GKjTw",
"recipient_type": "company",
"recipient": "com_zH8Gq33iBkFj5o0GKjTw",
"email_communication": null,
"created_at": "2024-01-19 17:04:15+00"
}
{
"id": "ntf_MrFrw0F82NSJjyw10Erk",
"topic": "ready_for_payroll",
"company": "com_zH8Gq33iBkFj5o0GKjTw",
"recipient_type": "company",
"recipient": "com_zH8Gq33iBkFj5o0GKjTw",
"email_communication": "cmn_MrFrw0F82NSJjyw10Erk",
"created_at": "2024-01-19 17:04:15+00"
}
| Attribute | Description |
|---|---|
| id string | Unique identifier of the notification. |
| topic string | Topic of the notification. |
| company string | ID of the company associated with the intended recipient of the notification. |
| recipient_type enum | Type of notification recipient. Can be company. |
| recipient string | ID of the intended recipient of the notification. |
| email_communication string | ID of the associated email communication created by Check. |
| created_at string | The time when the notification was created. |