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 enables you to perform subsequent processing logic in your application.

When subscribed to Notification webhooks you will 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: only some notifications can expire, not all.

📘
category describes the notification type
In order to retrieve more details about a notification, such as suggested copy for a notification message, please use GET v1/notifications/:notification_uuid.
For a list of currently available notification categories, see this page.

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