Monitoring Settings

To customize your monitoring, you can change the settings. The following settings can be changed:

• Notification Settings - You can change the notification settings to receive notifications by email or webhook.
• Monitoring Subjects - You can change the monitoring subjects to receive notifications for specific categories.

You can test test this in the Swagger UI.

Get current settings

To get the current settings, use the get settings endpoint:

GET https://api.creditchecken.nl/api/monitoring/settings

It will return the current settings like this:

{
  "notificationSettings": {
    "emailSubject": "CreditChecken monitoring",
    "daysInterval": 7,
    "webhook": {
      "url": "https://webhook.site/1a2b3c4d"
    },
  },
  "monitorSubjects": {
    "companyInformation": true,
    "scoreAndLimit": true,
    "historyPublicationsAndEvents": true,
    "directorsAndAdministrators": true,
    "concernRelations": true,
    "annualReports": true,
    "paymentBehavior": true,
    "shareHolders": true,
    "failurePossibilityNext12Months": true
  }
}

Notification Settings

To receive notifications, there are two options:

• Emails - You can receive notifications by email. You can set up email addresses by updating the settings. The email will be a generic CreditChecken email. You can customize the email subject.
• Webhooks - You can receive notifications by webhooks. You can set up webhooks by setting the webhook url in the settings. The webhook will contain the same information as the email.

It's possible to set the interval in days for the notifications.

Update notification settings

Send a patch request to the settings endpoint to update the notification settings:

PATCH https://api.creditchecken.nl/api/monitoring/settings

The object you send should look like this:

{
  "notificationSettings": {
    "emailSubject": "CreditChecken monitoring", // Email subject if emails are specified
    "daysInterval": 7, // Interval in days for notifications
    "webhook": { // Webhook if webhook is specified, leave from request if not (can't be both)
      "url": "https://webhook.site/1a2b3c4d"
    },
    "emails": [ // Webhook if webhook is specified, leave from request if not (can't be both)
      {
        "email": "[email protected]"
      }
    ]
  },
  //...
}

You need to provide the whole object. If the settings are successfully updated, you will receive the updated settings. You can't use both webhooks and emails at the same time. Leave one of them out of the request.

Monitoring Subjects

To determine what kind of notifications you want to receive, you can set up monitoring subjects. A monitoring subject is a category of notifications. For example, you can select the monitoring subject 'scoreAndLimit' to receive notifications when the credit score or credit limit of a company changes. You can select multiple monitoring subjects.

Table of all monitoring subjects

Monitoring subject	Description
companyInformation	Receive notifications when some general information of a company changes. For example, when the name or address of a company changes.
scoreAndLimit	Receive notifications when the scores or credit limit of a company changes.
historyPublicationsAndEvents	Receive notifications when the history of publications or events of a company changes.
directorsAndAdministrators	Receive notifications when the information of directors or administrators of a company changes. Or for example when a new director is added.
annualReports	Receive notifications when a new annual report is published.
paymentBehavior	Receive notifications when the payment behavior of a company changes.
shareHolders	Receive notifications when the shareholders of a company change.
failurePossibilityNext12Months	Receive notifications when the failure possibility of a company changes.

Update monitoring subjects

To update the monitoring subjects, use the patch settings endpoint and provide the full monitoring subjects object:

PATCH https://api.creditchecken.nl/api/monitoring/settings

For example, if you want to receive notifications for the monitoring subjects companyInformation and scoreAndLimit, you can use the following request:

{
  // ...
  "monitorSubjects": {
    "companyInformation": true,
    "scoreAndLimit": true,
    "historyPublicationsAndEvents": false,
    "directorsAndAdministrators": false,
    "concernRelations": false,
    "annualReports": false,
    "paymentBehavior": false,
    "shareHolders": false,
    "failurePossibilityNext12Months": false
  }
}

If the monitoring subjects are successfully updated, you will receive the updated settings.