Notification Events

Notification webhook events signify that a critical communication must be relayed to an end user. Other webhook event types indicate that an entity has been created, updated, or deleted, and they enable you to perform subsequent processing logic in your application.

Subscribe to Notification webhooks to receive the following events:

event_type	description
notification.{category}.created	A partner notification has been created
notification.{category}.resolved	A partner notification has been resolved
notification.{category}.expired	A partner notification has expired, meaning the notification is no longer applicable for a user. Note that only some notifications can expire; see Partner Notification Types for more information.

📘
category describes the notification type
For a list of available notification types, see Partner Notification Types.
To retrieve more details about a notification, such as the suggested copy for a notification message, use GET /v1/notifications/:notification_uuid: .

Example payloads

{
  "uuid": "63ea6df3-ebf8-4465-9382-e29516a56a52",
  "event_type": "notification.information_request.created",
  "resource_type": "Company",
  "resource_uuid": "f6a168b4-487d-4688-8812-911c86803b57",
  "entity_type": "Notification",
  "entity_uuid": "86e785b3-37a1-40ed-94e4-3cedd3f2fc90",
  "timestamp": 1688587457
}

{
  "uuid": "dd929277-ad89-4e8b-bb8b-cfd229b05b9a",
  "event_type": "notification.invalid_ssn.created",
  "resource_type": "Company",
  "resource_uuid": "f6a168b4-487d-4688-8812-911c86803b57",
  "entity_type": "Notification",
  "entity_uuid": "86e785b3-37a1-40ed-94e4-3cedd3f2fc90",
  "timestamp": 1688587457
}

📘category describes the notification type

Example payloads

📘
`category` describes the notification type