Configure Monitoring

Overview

Use this endpoint to start monitoring an SOS record for future changes.

Before creating a monitoring request, perform an SOS search and identify the specific SOS record that needs to be monitored. The SOS search request and selected record are used as the starting point for monitoring.

When monitoring is successfully created, Compliancely returns a unique monitoring_id. Store this ID in your application because it is used to retrieve the monitoring status, review monitoring attempts, access versions, update the configuration, and stop monitoring.

Before You Start

You should already have:

  • A completed SOS search request.
  • The request_id associated with the SOS search.
  • The initial_record_id of the SOS record that should be monitored.
  • The required monitoring frequency.

Monitoring Frequency

Configure how frequently Compliancely should check the SOS record for changes.

Supported frequencies are:

  • weekly
  • bi_weekly
  • monthly
  • quarterly

The frequency can be changed later using the Update SOS Monitoring endpoint.

Webhook Notifications

You can optionally provide webhook_urls when creating the monitoring request.

Webhooks allow your application to receive monitoring-related notifications without continuously polling the Monitoring APIs.

What Happens Next?

After the monitoring request is created:

  1. Compliancely creates a monitoring configuration for the selected SOS record.
  2. A unique monitoring_id is assigned.
  3. Monitoring is scheduled according to the configured frequency.
  4. Compliancely performs subsequent SOS checks.
  5. Monitoring attempts become available through the Timeline API.
  6. SOS data history and detected changes can be accessed through the Version APIs.

Keep the returned monitoring_id as the primary reference for the monitoring lifecycle.

Related APIs

After creating monitoring, you can:

  • Get Monitoring Details to check its current configuration and status.
  • Update SOS Monitoring to change its frequency or webhook configuration.
  • View Monitoring Timeline to review monitoring attempts.
  • List SOS Versions to review the SOS data history.
  • Stop Monitoring when monitoring is no longer required.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1
string
required
length ≥ 1
string
enum
required
Allowed:
webhook_urls
array
webhook_urls
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json