Monitor

๐Ÿ“˜

Premium Feature

Monitoring is available as a premium feature. Contact Sales to inquire more about access. If you're an existing customer, reach out to your Account Manager or to [email protected].

A Monitor object can be created for a Business to indicate event_types that you wish 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 we're monitoring for new Bankruptcies related to this Business. We would update the Business and send an Event to your Webhook if we detect a new Bankruptcy.

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 (e.g. "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 for which Middesk does not 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, we need 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.
"inactive"This event_type is not available for this Business, and the Business will not be monitored for changes related to this event_type.
"pending"It is not yet known if the Business can monitor this event_type (e.g. the Business is still processing)

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, visit this page here.

If you have something about a Business that you'd like to monitor and don't see it below, please reach out to [email protected].

event_typeDescriptionAvailability
bankruptcyA new Bankruptcy has been added to the monitored Business.Available if the monitored Business has SOS Registrations.
watchlist_resultA new Watchlist Result has been 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.