Monitor object

This page describes the monitor object, which enables ongoing surveillance of a business for specific event types (like bankruptcies, watchlist changes, or registration updates).

Create a monitor object for a business to indicate event_types that you want to monitor. A monitor with an active event_type means that Middesk is monitoring the business for events of that type. For example, the bankruptcy.created event type means that Middesk monitors for new bankruptcies related to this business. Middesk updates the business and sends an event to your webhook if a new bankruptcy is detected.

PropertyTypeDescription
event_typesobject[]A list of event types. Each list element is an object containing information about the current state of that type for this monitor.
created_attimestamp

The event_type object

PropertyTypeDescription
typestringThe name of the type (like bankruptcy.created).
statusstringThe status of the type, see below for possible values.

Event type statuses

It isn’t always possible to monitor all event_types for every business. For instance, a business where Middesk doesn’t find any SOS registrations cannot be monitored to for bankruptcies, as there would be no attributes to which to tie bankruptcies.

Monitor event_type.status tracks whether the monitor is active or inactive for a particular event_type. In some instances, Middesk needs to wait for the business to process to know the event_type.status. In this case, it would be pending.

ValueDescription
"active"The business is successfully monitoring this event_type.
"unavailable"This event_type is not available for this business or it is not yet known if the business can monitor this event_type (for example, the business is still processing), and the business will not be monitored for changes related to this event_type.

Live event types

Middesk currently offers monitoring on the following event types. For more information on what webhook requests to expect after creating a monitor, see Implement webhooks.

event_typeDescriptionAvailability
bankruptcyA new bankruptcy was added to the monitored business.Available if the monitored business has SOS registrations.
watchlist_resultA new watchlist result was added to the watchlist of the monitored business.Always available.
registrationA change has been detected for an SOS registration associated with this business. Monitored changes include added or removed names, addresses, people, and updates to registration status.Available if the monitored business has SOS registrations.
tinRuns checks on a set cadence for 2 weeks to find the TIN for a business that was previously unknown.Available for businesses with TIN submissions.
lienA new or terminated UCC lien has been detected for the monitored business. After the initial monitoring order, UCC lien checks are performed every two weeks to identify any changes.Available if account has UCC lien search enabled.
Get a demo
Contact your account manager or contact sales to inquire about access.