v1
latestOpenAPI 3.1.02026-07-2623108126.0 KBv1
Create webhook monitor
post/v1/monitor
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.
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.
disabledboolean required
Whether the monitor item is disabled.