ORoregister
v1

Create webhook monitor item

Changed on
post/v1/monitor

Request

  • Base URL
    https://api.openregister.de
  • Auth
    HTTP bearer

Request body

entity_type'company' | 'person' required

Type of the entity to monitor.

entity_idstring required

For company this is the register ID (e.g. DE-HRB-F1103-267645). For person this is the person UUID.

preferencesWebhookMonitorPreference[] required

Preferences for the entity to monitor. Use WebhookMonitorCompanyPreference values when entity_type is company, and WebhookMonitorPersonPreference values when entity_type is person.

update_frequency'daily' | 'weekly'

How often the monitored company is checked for register updates. Defaults to weekly if not provided.

Only supported when entity_type is company. Requests for person monitors that include this field are rejected with a validation error.

Daily monitors are billed at a premium: 50 credits at creation and 50 credits per month while active, instead of the standard 25.

Response

Success

entity_type'company' | 'person' required

Type of the entity to monitor.

entity_idstring required

For company this is the register ID (e.g. DE-HRB-F1103-267645). For person this is the person UUID.

preferencesWebhookMonitorPreference[] required

Preferences for the entity to monitor. Use WebhookMonitorCompanyPreference values when entity_type is company, and WebhookMonitorPersonPreference values when entity_type is person.

update_frequency'daily' | 'weekly' required

How often the monitored company is checked for register updates. Defaults to weekly if not provided.

Only supported when entity_type is company. Requests for person monitors that include this field are rejected with a validation error.

Daily monitors are billed at a premium: 50 credits at creation and 50 credits per month while active, instead of the standard 25.

disabledboolean required

Whether the monitor item is disabled.

Changes

  • d1fcaf6d6ca0Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

  • 4d85d3f35061Revision changes
    • warning

      added the new insolvencies enum value to the / response property for the response status

    • info

      added the new insolvencies enum value to the request property /