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.
The event_type object
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.
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.